2 个版本

0.1.1 2020年2月11日
0.1.0 2020年1月29日

#5 in #messenger

Apache-2.0

29KB
687

Cups CLI

Cups CLI 是一个基于终端的客户端,用于与 Start9 服务器上安装的 Cups Messenger 独立应用程序实例进行交互。

在基于 Mac 或 Linux 的机器上,您可以通过在全局搜索栏中搜索“终端”来找到终端。

以下内容中,'$' 表示以下文本应粘贴到终端中,然后按回车键运行命令。请不要复制 '$' 符号。有关安装问题,请通过 [email protected] 联系。

安装

需要 Rust

$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
$ source ~/.cargo/env

安装

$ cargo install cups-cli

用法

终端程序 cups-cli 已安装到您的系统上,您可以通过发出以下形式的请求来使用和调用它。

$ cups-cli <Command> <SubCommand> < ... arguments ... >

在此及以下内容中,硬角括号 < ... > 表示您将在命令中的这些位置输入几个选项之一。

配置

为了使用您的 Start9 服务器运行 cups-cli,您需要设置 cups-cli 程序,使其指向您的服务器。这通过配置 CUPS_HOST 和 CUPS_PASSWORD 完成。

打开您的 Start9 伴侣应用程序,点击运行 Cups Messenger 的服务器,点击右上角的 "..." 汉堡菜单,然后 "服务器规格"。第一行 "LAN IP" 将是您的 CUPS_HOST。要获取密码,导航到您安装的 Cups Messenger 应用程序,点击 "..." 切换菜单,然后 "应用程序配置"。

要将这些值传达给您的 cups-cli 终端程序,请在终端中运行以下命令,不要有额外的空格或引号

$ export CUPS_HOST=<your Cups onion url>
$ export CUPS_PASSWORD=<your Cups Messenger password>

命令和子命令

  • $ cups-cli contacts ... : contacts 命令允许您查看并添加新的联系人以发送消息。
    • $ cups-cli contacts show : 将您的联系人显示到屏幕上。
    • $ cups-cli contacts add <Friend's Tor address> <friend's name> : 要添加一个在他们的 S0 服务器上运行 Cups Messenger 的新联系人,您将需要他们在 Cups Messenger 页面上列出的 Tor 地址。
  • $ cups-cli messages ... : messages 命令允许您向您的联系人发送和查看消息。
    • $ cups-cli messages show < Friends's Tor address > :以你朋友的身份显示你的消息。
    • $ cups-cli messages send < message > < Friends's Tor address > :向你的朋友发送消息!

高级用法

  • 你可以通过使用-h和-p标志分别,命令行命令行地包含你的CUPS_HOST和CUPS_PASSWORD信息。
  • 这些变量也可以通过在你的~/.bash_profile(macOS)或~/.bashrc(Linux)中添加以下两行来设置:
export CUPS_HOST<your LAN IP>
export CUPS_PASSWORD=<your Cups Messager password>
  • 你可以使用$ cups-cli messages show <Friend's Tor address> --limit n来限制返回给你的消息数量

终端用户界面

正在进行中 当没有传递子命令时将启动,但尚未完全启用

依赖

~10-15MB
~251K SLoC