cups-cli 0.1.0

A minimal client for Cups Instant Messanger
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

# C.U.P.S. CLI

## Building
### Requires Rust
```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env
```
### Build
```cargo build --release```
### Add to PATH
```cp ./target/release/cups-cli /usr/local/bin```

## Usage
### Base arguments (REQUIRED)
  - HOST
    - Must be the LAN IP or .local address of your C.U.P.S. server
    - Can be set with either the `CUPS_HOST` environment var or `-h` command line flag
  - PASSWORD
    - Can be found in your Start9 Server config
    - Can be set with either the `CUPS_PASSWORD` environment var or `-p` command line flag
### Subcommands
  - contacts
    - show/list/ls
      - Shows contact book and unread messages
    - add
      - ADDRESS
        - Must be the .onion address of the contact
      - NAME
        - A friendly name for the contact
  - messages
    - show/list/ls
      - ADDRESS
        - Must be the .onion address of the contact you want to see message history with
      - `--limit` (optional)
        - set maximum number of messages to return
    - send
      - ADDRESS
        - Must be the .onion address of the intended recipient
      - MESSAGE
        - Your message to send. For best results, surround in quotes.

## Terminal User Interface
**WORK IN PROGRESS**
Will start up when no subcommand is passed, however is not in a fully functional state