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 signal-cli is a commandline interface for libsignal-service-java.
  19 It supports registering, verifying, sending and receiving messages.
  20 For registering you need a phone number where you can receive SMS or incoming calls.
  21 signal-cli was primarily developed to be used on servers to notify admins of important events.
  22 For this use-case, it has a dbus interface, that can be used to send messages from any programming language that has dbus bindings.
  23
  24 == Options
  25
  26 *-h*, *--help*::
  27 Show help message and quit.
  28
  29 *-v*, *--version*::
  30 Print the version and quit.
  31
  32 *--config* CONFIG::
  33 Set the path, where to store the config.
  34 Make sure you have full read/write access to the given directory.
  35 (Default: `$XDG_DATA_HOME/signal-cli` (`$HOME/.local/share/signal-cli`))
  36
  37 *-u* USERNAME, *--username* USERNAME::
  38 Specify your phone number, that will be your identifier.
  39 The phone number must include the country calling code, i.e. the number must start with a "+" sign.
  40
  41 *--dbus*::
  42 Make request via user dbus.
  43
  44 *--dbus-system*::
  45 Make request via system dbus.
  46
  47 == Commands
  48
  49 === register
  50
  51 Register a phone number with SMS or voice verification.
  52 Use the verify command to complete the verification.
  53
  54 *-v*, *--voice*::
  55 The verification should be done over voice, not SMS.
  56
  57 *--captcha*::
  58 The captcha token, required if registration failed with a captcha required error.
  59 To get the token, go to https://signalcaptchas.org/registration/generate.html
  60 Check the developer tools for a redirect starting with signalcaptcha://
  61 Everything after signalcaptcha:// is the captcha token.
  62
  63 === verify
  64
  65 Verify the number using the code received via SMS or voice.
  66
  67 VERIFICATIONCODE::
  68 The verification code.
  69
  70 *-p* PIN, *--pin* PIN::
  71 The registration lock PIN, that was set by the user.
  72 Only required if a PIN was set.
  73
  74 === unregister
  75
  76 Disable push support for this device, i.e. this device won't receive any more messages.
  77 If this is the master device, other users can't send messages to this number anymore.
  78 Use "updateAccount" to undo this.
  79 To remove a linked device, use "removeDevice" from the master device.
  80
  81 === updateAccount
  82
  83 Update the account attributes on the signal server.
  84 Can fix problems with receiving messages.
  85
  86 === setPin
  87
  88 Set a registration lock pin, to prevent others from registering this number.
  89
  90 REGISTRATION_LOCK_PIN::
  91 The registration lock PIN, that will be required for new registrations (resets after 7 days of inactivity)
  92
  93 === removePin
  94
  95 Remove the registration lock pin.
  96
  97 === link
  98
  99 Link to an existing device, instead of registering a new number.
 100 This shows a "tsdevice:/…" URI. If you want to connect to another signal-cli instance, you can just use this URI. If you want to link to an Android/iOS device, create a QR code with the URI (e.g. with qrencode) and scan that in the Signal app.
 101
 102 *-n* NAME, *--name* NAME::
 103 Optionally specify a name to describe this new device.
 104 By default "cli" will be used.
 105
 106 === addDevice
 107
 108 Link another device to this device.
 109 Only works, if this is the master device.
 110
 111 *--uri* URI::
 112 Specify the uri contained in the QR code shown by the new device. You will need the full uri enclosed in quotation marks, such as "tsdevice:/?uuid=....."
 113
 114 === listDevices
 115
 116 Show a list of connected devices.
 117
 118 === removeDevice
 119
 120 Remove a connected device.
 121 Only works, if this is the master device.
 122
 123 *-d* DEVICEID, *--deviceId* DEVICEID::
 124 Specify the device you want to remove.
 125 Use listDevices to see the deviceIds.
 126
 127 === send
 128
 129 Send a message to another user or group.
 130
 131 RECIPIENT::
 132 Specify the recipients’ phone number.
 133
 134 *-g* GROUP, *--group* GROUP::
 135 Specify the recipient group ID in base64 encoding.
 136
 137 *-m* MESSAGE, *--message* MESSAGE::
 138 Specify the message, if missing, standard input is used.
 139
 140 *-a* [ATTACHMENT [ATTACHMENT ...]], *--attachment* [ATTACHMENT [ATTACHMENT ...]]::
 141 Add one or more files as attachment.
 142
 143 *-e*, *--endsession*::
 144 Clear session state and send end session message.
 145
 146 === sendReaction
 147
 148 Send reaction to a previously received or sent message.
 149
 150 RECIPIENT::
 151 Specify the recipients’ phone number.
 152
 153 *-g* GROUP, *--group* GROUP::
 154 Specify the recipient group ID in base64 encoding.
 155
 156 *-e* EMOJI, *--emoji* EMOJI::
 157 Specify the emoji, should be a single unicode grapheme cluster.
 158
 159 *-a* NUMBER, *--target-author* NUMBER::
 160 Specify the number of the author of the message to which to react.
 161
 162 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
 163 Specify the timestamp of the message to which to react.
 164
 165 *-r*, *--remove*::
 166 Remove a reaction.
 167
 168 === receive
 169
 170 Query the server for new messages.
 171 New messages are printed on standardoutput and attachments are downloaded to the config directory.
 172
 173 *-t* TIMEOUT, *--timeout* TIMEOUT::
 174 Number of seconds to wait for new messages (negative values disable timeout).
 175 Default is 5 seconds.
 176 *--ignore-attachments*::
 177 Don’t download attachments of received messages.
 178 *--json*::
 179 Output received messages in json format, one object per line.
 180
 181 === updateGroup
 182
 183 Create or update a group.
 184
 185 *-g* GROUP, *--group* GROUP::
 186 Specify the recipient group ID in base64 encoding.
 187 If not specified, a new group with a new random ID is generated.
 188
 189 *-n* NAME, *--name* NAME::
 190 Specify the new group name.
 191
 192 *-a* AVATAR, *--avatar* AVATAR::
 193 Specify a new group avatar image file.
 194
 195 *-m* [MEMBER [MEMBER ...]], *--member* [MEMBER [MEMBER ...]]::
 196 Specify one or more members to add to the group.
 197
 198 === quitGroup
 199
 200 Send a quit group message to all group members and remove self from member list.
 201
 202 *-g* GROUP, *--group* GROUP::
 203 Specify the recipient group ID in base64 encoding.
 204
 205 === listGroups
 206
 207 Show a list of known groups.
 208
 209 *-d*, *--detailed*::
 210 Include the list of members of each group.
 211
 212 === listIdentities
 213
 214 List all known identity keys and their trust status, fingerprint and safety number.
 215
 216 *-n* NUMBER, *--number* NUMBER::
 217 Only show identity keys for the given phone number.
 218
 219 === trust
 220
 221 Set the trust level of a given number.
 222 The first time a key for a number is seen, it is trusted by default (TOFU).
 223 If the key changes, the new key must be trusted manually.
 224
 225 number::
 226 Specify the phone number, for which to set the trust.
 227
 228 *-a*, *--trust-all-known-keys*::
 229 Trust all known keys of this user, only use this for testing.
 230
 231 *-v* VERIFIED_SAFETY_NUMBER, *--verified-safety-number* VERIFIED_SAFETY_NUMBER::
 232 Specify the safety number of the key, only use this option if you have verified the safety number.
 233
 234 === updateProfile
 235
 236 Update the name and avatar image visible by message recipients for the current users.
 237 The profile is stored encrypted on the Signal servers.
 238 The decryption key is sent with every outgoing messages (excluding group messages).
 239
 240 *--name*::
 241 New name visible by message recipients.
 242
 243 *--avatar*::
 244 Path to the new avatar visible by message recipients.
 245
 246 *--remove-avatar*::
 247 Remove the avatar visible by message recipients.
 248
 249 === updateContact
 250
 251 Update the info associated to a number on our contact list.
 252 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 253 If the contact doesn't exist yet, it will be added.
 254
 255 NUMBER::
 256 Specify the contact phone number.
 257
 258 *-n*, *--name*::
 259 Specify the new name for this contact.
 260
 261 *-e*, *--expiration*::
 262 Set expiration time of messages (seconds).
 263 To disable expiration set expiration time to 0.
 264
 265 === block
 266
 267 Block the given contacts or groups (no messages will be received).
 268 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 269
 270 [CONTACT [CONTACT ...]]::
 271 Specify the phone numbers of contacts that should be blocked.
 272
 273 *-g* [GROUP [GROUP ...]], *--group* [GROUP [GROUP ...]]::
 274 Specify the group IDs that should be blocked in base64 encoding.
 275
 276 === unblock
 277
 278 Unblock the given contacts or groups (messages will be received again).
 279 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 280
 281 [CONTACT [CONTACT ...]]::
 282 Specify the phone numbers of contacts that should be unblocked.
 283
 284 *-g* [GROUP [GROUP ...]], *--group* [GROUP [GROUP ...]]::
 285 Specify the group IDs that should be unblocked in base64 encoding.
 286
 287 === sendContacts
 288
 289 Send a synchronization message with the local contacts list to all linked devices.
 290 This command should only be used if this is the master device.
 291
 292 === uploadStickerPack
 293
 294 Upload a new sticker pack, consisting of a manifest file and the stickers in WebP format (maximum size for a sticker file is 100KiB).
 295 The required manifest.json has the following format:
 296
 297 [source,json]
 298 ----
 299 {
 300   "title": "<STICKER_PACK_TITLE>",
 301   "author": "<STICKER_PACK_AUTHOR>",
 302   "cover": { // Optional cover, by default the first sticker is used as cover
 303     "file": "<name of webp file, mandatory>",
 304     "emoji": "<optional>"
 305   },
 306   "stickers": [
 307     {
 308       "file": "<name of webp file, mandatory>",
 309       "emoji": "<optional>"
 310     }
 311     ...
 312   ]
 313 }
 314 ----
 315
 316 PATH::
 317 The path of the manifest.json or a zip file containing the sticker pack you wish to upload.
 318
 319 === daemon
 320
 321 signal-cli can run in daemon mode and provides an experimental dbus interface.
 322
 323 *--system*::
 324 Use DBus system bus instead of user bus.
 325 *--ignore-attachments*::
 326 Don’t download attachments of received messages.
 327
 328 == Examples
 329
 330 Register a number (with SMS verification)::
 331 signal-cli -u USERNAME register
 332
 333 Verify the number using the code received via SMS or voice::
 334 signal-cli -u USERNAME verify CODE
 335
 336 Send a message to one or more recipients::
 337 signal-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
 338
 339 Pipe the message content from another process::
 340 uname -a | signal-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
 341
 342 Create a group::
 343 signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
 344
 345 Add member to a group::
 346 signal-cli -u USERNAME updateGroup -g GROUP_ID -m "NEW_MEMBER"
 347
 348 Leave a group::
 349 signal-cli -u USERNAME quitGroup -g GROUP_ID
 350
 351 Send a message to a group::
 352 signal-cli -u USERNAME send -m "This is a message" -g GROUP_ID
 353
 354 Trust new key, after having verified it::
 355 signal-cli -u USERNAME trust -v SAFETY_NUMBER NUMBER
 356
 357 Trust new key, without having verified it. Only use this if you don't care about security::
 358 signal-cli -u USERNAME trust -a NUMBER
 359
 360 == Files
 361
 362 The password and cryptographic keys are created when registering and stored in the current users home directory, the directory can be changed with *--config*:
 363
 364 `$XDG_DATA_HOME/signal-cli/` (`$HOME/.local/share/signal-cli/`)
 365
 366 For legacy users, the old config directories are used as a fallback:
 367
 368     $HOME/.config/signal/
 369
 370     $HOME/.config/textsecure/
 371
 372 == Authors
 373
 374 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
 375 For more information about signal-cli development, see
 376 <https://github.com/AsamK/signal-cli>.