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