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