nmode's Git Repositories - signal-cli/blob - man/signal-cli.1.adoc

   1 /////
   2 vim:set ts=4 sw=4 tw=82 noet:
   3 /////
   4 :quotes.~:
   5
   6 = signal-cli (1)
   7
   8 Name
   9 ----
  10 signal-cli - A commandline and dbus interface for the Signal messenger
  11
  12 Synopsis
  13 --------
  14 *signal-cli* [--config CONFIG] [-h | -v | -u USERNAME | --dbus | --dbus-system] command [command-options]
  15
  16 Description
  17 -----------
  18
  19 signal-cli is a commandline interface for libsignal-service-java. It supports
  20 registering, verifying, sending and receiving messages. For registering you need a
  21 phone number where you can receive SMS or incoming calls.
  22 signal-cli was primarily developed to be used on servers to notify admins of
  23 important events. For this use-case, it has a dbus interface, that can be used to
  24 send messages from any programming language that has dbus bindings.
  25
  26 Options
  27 -------
  28
  29 *-h*, *--help*::
  30         Show help message and quit.
  31
  32 *-v*, *--version*::
  33         Print the version and quit.
  34
  35 *--config* CONFIG::
  36         Set the path, where to store the config.
  37         (Default: $HOME/.config/signal)
  38
  39 *-u* USERNAME, *--username* USERNAME::
  40         Specify your phone number, that will be your identifier.
  41         The phone number must include the country calling code, i.e. the number must
  42         start with a "+" sign.
  43
  44 *--dbus*::
  45         Make request via user dbus.
  46
  47 *--dbus-system*::
  48         Make request via system dbus.
  49
  50 Commands
  51 --------
  52
  53 register
  54 ~~~~~~~~
  55 Register a phone number with SMS or voice verification. Use the verify command to
  56 complete the verification.
  57
  58 *-v*, *--voice*::
  59         The verification should be done over voice, not SMS.
  60
  61 verify
  62 ~~~~~~
  63 Verify the number using the code received via SMS or voice.
  64
  65 VERIFICATIONCODE::
  66         The verification code.
  67
  68 unregister
  69 ~~~~~~~~~~
  70 Disable push support for this device, i.e. this device won't receive any more messages.
  71 If this is the master device, other users can't send messages to this number anymore.
  72 Use "updateAccount" to undo this.
  73 To remove a linked device, use "removeDevice" from the master device.
  74
  75 updateAccount
  76 ~~~~~~~~~~~~~
  77 Update the account attributes on the signal server.
  78 Can fix problems with receiving messages.
  79
  80 link
  81 ~~~~
  82 Link to an existing device, instead of registering a new number.  This shows a
  83 "tsdevice:/…" URI. If you want to connect to another signal-cli instance, you can
  84 just use this URI. If you want to link to an Android/iOS device, create a QR code
  85 with the URI (e.g. with qrencode) and scan that in the Signal app.
  86
  87 *-n* NAME, *--name* NAME::
  88         Optionally specify a name to describe this new device. By default "cli" will
  89         be used.
  90
  91 addDevice
  92 ~~~~~~~~~
  93 Link another device to this device. Only works, if this is the master device.
  94
  95 *--uri* URI::
  96         Specify the uri contained in the QR code shown by the new device.
  97
  98 listDevices
  99 ~~~~~~~~~~~
 100 Show a list of connected devices.
 101
 102 removeDevice
 103 ~~~~~~~~~~~~
 104 Remove a connected device. Only works, if this is the master device.
 105
 106 *-d* DEVICEID, *--deviceId* DEVICEID::
 107         Specify the device you want to remove. Use listDevices to see the deviceIds.
 108
 109 send
 110 ~~~~
 111 Send a message to another user or group.
 112
 113 RECIPIENT::
 114         Specify the recipients’ phone number.
 115
 116 *-g* GROUP, *--group* GROUP::
 117         Specify the recipient group ID in base64 encoding.
 118
 119 *-m* MESSAGE, *--message* MESSAGE::
 120         Specify the message, if missing, standard input is used.
 121
 122 *-a* [ATTACHMENT [ATTACHMENT ...]], *--attachment* [ATTACHMENT [ATTACHMENT ...]]::
 123         Add one or more files as attachment.
 124
 125 *-e*, *--endsession*::
 126         Clear session state and send end session message.
 127
 128 receive
 129 ~~~~~~~
 130 Query the server for new messages. New messages are printed on standardoutput and
 131 attachments are downloaded to the config directory.
 132
 133 *-t* TIMEOUT, *--timeout* TIMEOUT::
 134         Number of seconds to wait for new messages (negative values disable timeout).
 135         Default is 5 seconds.
 136 *--ignore-attachments*::
 137         Don’t download attachments of received messages.
 138
 139 updateGroup
 140 ~~~~~~~~~~~
 141 Create or update a group.
 142
 143 *-g* GROUP, *--group* GROUP::
 144         Specify the recipient group ID in base64 encoding. If not specified, a new
 145         group with a new random ID is generated.
 146
 147 *-n* NAME, *--name* NAME::
 148         Specify the new group name.
 149
 150 *-a* AVATAR, *--avatar* AVATAR::
 151         Specify a new group avatar image file.
 152
 153 *-m* [MEMBER [MEMBER ...]], *--member* [MEMBER [MEMBER ...]]::
 154         Specify one or more members to add to the group.
 155
 156 quitGroup
 157 ~~~~~~~~~
 158 Send a quit group message to all group members and remove self from member list.
 159
 160 *-g* GROUP, *--group* GROUP::
 161         Specify the recipient group ID in base64 encoding.
 162
 163 listGroups
 164 ~~~~~~~~~~~
 165 Show a list of known groups.
 166
 167 *-d*, *--detailed*::
 168         Include the list of members of each group.
 169
 170 listIdentities
 171 ~~~~~~~~~~~~~~
 172 List all known identity keys and their trust status, fingerprint and safety
 173 number.
 174
 175 *-n* NUMBER, *--number* NUMBER::
 176         Only show identity keys for the given phone number.
 177
 178 trust
 179 ~~~~~
 180 Set the trust level of a given number. The first time a key for a number is seen,
 181 it is trusted by default (TOFU). If the key changes, the new key must be trusted
 182 manually.
 183
 184 number::
 185         Specify the phone number, for which to set the trust.
 186
 187 *-a*, *--trust-all-known-keys*::
 188         Trust all known keys of this user, only use this for testing.
 189
 190 *-v* VERIFIED_FINGERPRINT, *--verified-fingerprint* VERIFIED_FINGERPRINT::
 191         Specify the safety number or fingerprint of the key, only use this option if you have verified
 192         the fingerprint.
 193
 194
 195 daemon
 196 ~~~~~~
 197 signal-cli can run in daemon mode and provides an experimental dbus interface. For
 198 dbus support you need jni/unix-java.so installed on your system (Debian:
 199 libunixsocket-java ArchLinux: libmatthew-unix-java (AUR)).
 200
 201 *--system*::
 202         Use DBus system bus instead of user bus.
 203 *--ignore-attachments*::
 204         Don’t download attachments of received messages.
 205
 206
 207 Examples
 208 --------
 209
 210 Register a number (with SMS verification)::
 211     signal-cli -u USERNAME register
 212
 213 Verify the number using the code received via SMS or voice::
 214     signal-cli -u USERNAME verify CODE
 215
 216 Send a message to one or more recipients::
 217     signal-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
 218
 219 Pipe the message content from another process::
 220     uname -a | signal-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
 221
 222 Create a group::
 223         signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
 224
 225 Add member to a group::
 226         signal-cli -u USERNAME updateGroup -g GROUP_ID -m "NEW_MEMBER"
 227
 228 Leave a group::
 229         signal-cli -u USERNAME quitGroup -g GROUP_ID
 230
 231 Send a message to a group::
 232         signal-cli -u USERNAME send -m "This is a message" -g GROUP_ID
 233
 234 Trust new key, after having verified it::
 235     signal-cli -u USERNAME trust -v FINGER_PRINT NUMBER
 236
 237 Trust new key, without having verified it. Only use this if you don't care about security::
 238     signal-cli -u USERNAME trust -a NUMBER
 239
 240 Files
 241 -----
 242 The password and cryptographic keys are created when registering and stored in the
 243 current users home directory, the directory can be changed with *--config*:
 244
 245     $HOME/.config/signal/
 246
 247 For legacy users, the old config directory is used as a fallback:
 248
 249     $HOME/.config/textsecure/
 250
 251
 252 Authors
 253 -------
 254
 255 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open
 256 source contributors. For more information about signal-cli development, see
 257 <https://github.com/AsamK/signal-cli>.