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 *--trust-new-identities* TRUST-MODE::
  62 Choose when to trust new identities:
  63 - `on-first-use` (default): Trust the first seen identity key from new users,
  64   changed keys must be verified manually
  65 - `always`: Trust any new identity key without verification
  66 - `never`: Don't trust any unknown identity key, every key must be verified manually
  67
  68 == Commands
  69
  70 === register
  71
  72 Register a phone number with SMS or voice verification.
  73 Use the verify command to complete the verification.
  74
  75 *-v*, *--voice*::
  76 The verification should be done over voice, not SMS.
  77
  78 *--captcha*::
  79 The captcha token, required if registration failed with a captcha required error.
  80 To get the token, go to https://signalcaptchas.org/registration/generate.html
  81 Check the developer tools for a redirect starting with signalcaptcha://
  82 Everything after signalcaptcha:// is the captcha token.
  83
  84 === verify
  85
  86 Verify the number using the code received via SMS or voice.
  87
  88 VERIFICATIONCODE::
  89 The verification code.
  90
  91 *-p* PIN, *--pin* PIN::
  92 The registration lock PIN, that was set by the user.
  93 Only required if a PIN was set.
  94
  95 === unregister
  96
  97 Disable push support for this device, i.e. this device won't receive any more messages.
  98 If this is the master device, other users can't send messages to this number anymore.
  99 Use "updateAccount" to undo this.
 100 To remove a linked device, use "removeDevice" from the master device.
 101
 102 *--delete-account*::
 103 Delete account completely from server. Cannot be undone without loss. You will
 104 have to be readded to each group.
 105
 106 CAUTION: Only delete your account if you won't use this number again!
 107
 108 === updateAccount
 109
 110 Update the account attributes on the signal server.
 111 Can fix problems with receiving messages.
 112
 113 *-n* NAME, *--device-name* NAME::
 114 Set a new device name for the main or linked device
 115
 116 === updateConfiguration
 117
 118 Update signal configs and sync them to linked devices.
 119 This command only works on the main devices.
 120
 121 *--read-receipts* {true,false}::
 122 Indicates if Signal should send read receipts.
 123
 124 *--unidentified-delivery-indicators* {true,false}::
 125 Indicates if Signal should show unidentified delivery indicators.
 126
 127 *--typing-indicators* {true,false}::
 128 Indicates if Signal should send/show typing indicators.
 129
 130 *--link-previews* {true,false}::
 131 Indicates if Signal should generate link previews.
 132
 133 === setPin
 134
 135 Set a registration lock pin, to prevent others from registering this number.
 136
 137 REGISTRATION_LOCK_PIN::
 138 The registration lock PIN, that will be required for new registrations (resets after 7 days of inactivity)
 139
 140 === removePin
 141
 142 Remove the registration lock pin.
 143
 144 === link
 145
 146 Link to an existing device, instead of registering a new number.
 147 This shows a "sgnl://linkdevice/?uuid=..." URI. If you want to connect to another signal-cli instance, you can just use this URI.
 148 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.
 149
 150 *-n* NAME, *--name* NAME::
 151 Optionally specify a name to describe this new device.
 152 By default "cli" will be used.
 153
 154 === addDevice
 155
 156 Link another device to this device.
 157 Only works, if this is the master device.
 158
 159 *--uri* URI::
 160 Specify the uri contained in the QR code shown by the new device.
 161 You will need the full URI such as "sgnl://linkdevice/?uuid=..." (formerly "tsdevice:/?uuid=...")
 162 Make sure to enclose it in quotation marks for shells.
 163
 164 === listDevices
 165
 166 Show a list of linked devices.
 167
 168 === removeDevice
 169
 170 Remove a linked device.
 171 Only works, if this is the master device.
 172
 173 *-d* DEVICE_ID, *--device-id* DEVICE_ID::
 174 Specify the device you want to remove.
 175 Use listDevices to see the deviceIds.
 176
 177 === getUserStatus
 178
 179 Uses a list of phone numbers to determine the statuses of those users.
 180 Shows if they are registered on the Signal Servers or not.
 181 In json mode this is outputted as a list of objects.
 182
 183 [NUMBER [NUMBER ...]]::
 184 One or more numbers to check.
 185
 186 === send
 187
 188 Send a message to another user or group.
 189
 190 RECIPIENT::
 191 Specify the recipients’ phone number.
 192
 193 *-g* GROUP, *--group-id* GROUP::
 194 Specify the recipient group ID in base64 encoding.
 195
 196 *-m* MESSAGE, *--message* MESSAGE::
 197 Specify the message, if missing, standard input is used.
 198
 199 *-a* [ATTACHMENT [ATTACHMENT ...]], *--attachment* [ATTACHMENT [ATTACHMENT ...]]::
 200 Add one or more files as attachment.
 201
 202 *--note-to-self*::
 203 Send the message to self without notification.
 204
 205 *-e*, *--end-session*::
 206 Clear session state and send end session message.
 207
 208 === sendReaction
 209
 210 Send reaction to a previously received or sent message.
 211
 212 RECIPIENT::
 213 Specify the recipients’ phone number.
 214
 215 *-g* GROUP, *--group-id* GROUP::
 216 Specify the recipient group ID in base64 encoding.
 217
 218 *-e* EMOJI, *--emoji* EMOJI::
 219 Specify the emoji, should be a single unicode grapheme cluster.
 220
 221 *-a* NUMBER, *--target-author* NUMBER::
 222 Specify the number of the author of the message to which to react.
 223
 224 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
 225 Specify the timestamp of the message to which to react.
 226
 227 *-r*, *--remove*::
 228 Remove a reaction.
 229
 230 === sendReceipt
 231
 232 Send a read or viewed receipt to a previously received message.
 233
 234 RECIPIENT::
 235 Specify the sender’s phone number.
 236
 237 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
 238 Specify the timestamp of the message to which to react.
 239
 240 *--type* TYPE::
 241 Specify the receipt type, either `read` (the default) or `viewed`.
 242
 243 === sendTyping
 244
 245 Send typing message to trigger a typing indicator for the recipient.
 246 Indicator will be shown for 15seconds unless a typing STOP message is sent first.
 247
 248 RECIPIENT::
 249 Specify the recipients’ phone number.
 250
 251 *-g* GROUP, *--group-id* GROUP::
 252 Specify the recipient group ID in base64 encoding.
 253
 254 *-s*, *--stop*::
 255 Send a typing STOP message.
 256
 257 === remoteDelete
 258
 259 Remotely delete a previously sent message.
 260
 261 RECIPIENT::
 262 Specify the recipients’ phone number.
 263
 264 *-g* GROUP, *--group-id* GROUP::
 265 Specify the recipient group ID in base64 encoding.
 266
 267 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
 268 Specify the timestamp of the message to delete.
 269
 270 === receive
 271
 272 Query the server for new messages.
 273 New messages are printed on standard output and attachments are downloaded to the config directory.
 274 In json mode this is outputted as one json object per line.
 275
 276 *-t* TIMEOUT, *--timeout* TIMEOUT::
 277 Number of seconds to wait for new messages (negative values disable timeout).
 278 Default is 5 seconds.
 279 *--ignore-attachments*::
 280 Don’t download attachments of received messages.
 281
 282 === joinGroup
 283
 284 Join a group via an invitation link.
 285
 286 *--uri*::
 287 The invitation link URI (starts with `https://signal.group/#`)
 288
 289 === updateGroup
 290
 291 Create or update a group.
 292 If the user is a pending member, this command will accept the group invitation.
 293
 294 *-g* GROUP, *--group-id* GROUP::
 295 Specify the recipient group ID in base64 encoding.
 296 If not specified, a new group with a new random ID is generated.
 297
 298 *-n* NAME, *--name* NAME::
 299 Specify the new group name.
 300
 301 *-d* DESCRIPTION, *--description* DESCRIPTION::
 302 Specify the new group description.
 303
 304 *-a* AVATAR, *--avatar* AVATAR::
 305 Specify a new group avatar image file.
 306
 307 *-m* [MEMBER [MEMBER ...]], *--member* [MEMBER [MEMBER ...]]::
 308 Specify one or more members to add to the group.
 309
 310 *-r* [MEMBER [MEMBER ...]], *--remove-member* [MEMBER [MEMBER ...]]::
 311 Specify one or more members to remove from the group
 312
 313 *--admin* [MEMBER [MEMBER ...]]::
 314 Specify one or more members to make a group admin
 315
 316 *--remove-admin* [MEMBER [MEMBER ...]]::
 317 Specify one or more members to remove group admin privileges
 318
 319 *--reset-link*::
 320 Reset group link and create new link password
 321
 322 *--link* LINK_STATE::
 323 Set group link state: `enabled`, `enabled-with-approval`, `disabled`
 324
 325 *--set-permission-add-member* PERMISSION::
 326 Set permission to add new group members: `every-member`, `only-admins`
 327
 328 *--set-permission-edit-details* PERMISSION::
 329 Set permission to edit group details: `every-member`, `only-admins`
 330
 331 *--set-permission-send-messages* PERMISSION::
 332 Set permission to send messages in group: `every-member`, `only-admins`
 333 Groups where only admins can send messages are also called announcement groups
 334
 335 *-e* EXPIRATION_SECONDS, *--expiration* EXPIRATION_SECONDS::
 336 Set expiration time of messages (seconds).
 337 To disable expiration set expiration time to 0.
 338
 339 === quitGroup
 340
 341 Send a quit group message to all group members and remove self from member list.
 342 If the user is a pending member, this command will decline the group invitation.
 343
 344 *-g* GROUP, *--group-id* GROUP::
 345 Specify the recipient group ID in base64 encoding.
 346
 347 *--delete*::
 348 Delete local group data completely after quitting group.
 349
 350 === listGroups
 351
 352 Show a list of known groups and related information.
 353 In json mode this is outputted as an list of objects and is always in detailed mode.
 354
 355 *-d*, *--detailed*::
 356 Include the list of members of each group and the group invite link.
 357
 358 === listContacts
 359
 360 Show a list of known contacts with names.
 361
 362 === listIdentities
 363
 364 List all known identity keys and their trust status, fingerprint and safety number.
 365
 366 *-n* NUMBER, *--number* NUMBER::
 367 Only show identity keys for the given phone number.
 368
 369 === trust
 370
 371 Set the trust level of a given number.
 372 The first time a key for a number is seen, it is trusted by default (TOFU).
 373 If the key changes, the new key must be trusted manually.
 374
 375 number::
 376 Specify the phone number, for which to set the trust.
 377
 378 *-a*, *--trust-all-known-keys*::
 379 Trust all known keys of this user, only use this for testing.
 380
 381 *-v* VERIFIED_SAFETY_NUMBER, *--verified-safety-number* VERIFIED_SAFETY_NUMBER::
 382 Specify the safety number of the key, only use this option if you have verified the safety number.
 383 Can be either the plain text numbers shown in the app or the bytes from the QR-code,
 384 encoded as base64.
 385
 386 === updateProfile
 387
 388 Update the profile information shown to message recipients.
 389 The profile is stored encrypted on the Signal servers.
 390 The decryption key is sent with every outgoing messages to contacts and included
 391 in every group.
 392
 393 *--given-name* NAME, *--name* NAME::
 394 New (given) name.
 395
 396 *--family-name* FAMILY_NAME::
 397 New family name.
 398
 399 *--about* ABOUT_TEXT::
 400 New profile status text.
 401
 402 *--about-emoji* EMOJI::
 403 New profile status emoji.
 404
 405 *--avatar* AVATAR_FILE::
 406 Path to the new avatar image file.
 407
 408 *--remove-avatar*::
 409 Remove the avatar
 410
 411 === updateContact
 412
 413 Update the info associated to a number on our contact list.
 414 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 415 If the contact doesn't exist yet, it will be added.
 416
 417 NUMBER::
 418 Specify the contact phone number.
 419
 420 *-n*, *--name*::
 421 Specify the new name for this contact.
 422
 423 *-e*, *--expiration* EXPIRATION_SECONDS::
 424 Set expiration time of messages (seconds).
 425 To disable expiration set expiration time to 0.
 426
 427 === block
 428
 429 Block the given contacts or groups (no messages will be received).
 430 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 431
 432 [CONTACT [CONTACT ...]]::
 433 Specify the phone numbers of contacts that should be blocked.
 434
 435 *-g* [GROUP [GROUP ...]], *--group-id* [GROUP [GROUP ...]]::
 436 Specify the group IDs that should be blocked in base64 encoding.
 437
 438 === unblock
 439
 440 Unblock the given contacts or groups (messages will be received again).
 441 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 442
 443 [CONTACT [CONTACT ...]]::
 444 Specify the phone numbers of contacts that should be unblocked.
 445
 446 *-g* [GROUP [GROUP ...]], *--group-id* [GROUP [GROUP ...]]::
 447 Specify the group IDs that should be unblocked in base64 encoding.
 448
 449 === sendContacts
 450
 451 Send a synchronization message with the local contacts list to all linked devices.
 452 This command should only be used if this is the master device.
 453
 454 === sendSyncRequest
 455
 456 Send a synchronization request message to the master device (for group, contacts, ...).
 457 The master device will respond with synchronization messages with full contact and
 458 group lists.
 459
 460 === uploadStickerPack
 461
 462 Upload a new sticker pack, consisting of a manifest file and the sticker images.
 463 Images must conform to the following specification: (see https://support.signal.org/hc/en-us/articles/360031836512-Stickers#sticker_reqs )
 464 - Static stickers in PNG or WebP format
 465 - Animated stickers in APNG format,
 466 - Maximum file size for a sticker file is 300KiB
 467 - Image resolution of 512 x 512 px
 468
 469 The required manifest.json has the following format:
 470
 471 [source,json]
 472 ----
 473 {
 474   "title": "<STICKER_PACK_TITLE>",
 475   "author": "<STICKER_PACK_AUTHOR>",
 476   "cover": { // Optional cover, by default the first sticker is used as cover
 477     "file": "<name of image file, mandatory>",
 478     "contentType": "<optional>",
 479     "emoji": "<optional>"
 480   },
 481   "stickers": [
 482     {
 483       "file": "<name of image file, mandatory>",
 484       "contentType": "<optional>",
 485       "emoji": "<optional>"
 486     }
 487     ...
 488   ]
 489 }
 490 ----
 491
 492 PATH::
 493 The path of the manifest.json or a zip file containing the sticker pack you wish to upload.
 494
 495 === daemon
 496
 497 signal-cli can run in daemon mode and provides an experimental dbus interface.
 498 If no `-u` username is given, all local users will be exported as separate dbus
 499 objects under the same bus name.
 500
 501 *--system*::
 502 Use DBus system bus instead of user bus.
 503 *--ignore-attachments*::
 504 Don’t download attachments of received messages.
 505
 506 == Examples
 507
 508 Register a number (with SMS verification)::
 509 signal-cli -u USERNAME register
 510
 511 Verify the number using the code received via SMS or voice::
 512 signal-cli -u USERNAME verify CODE
 513
 514 Send a message to one or more recipients::
 515 signal-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
 516
 517 Pipe the message content from another process::
 518 uname -a | signal-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
 519
 520 Create a group::
 521 signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
 522
 523 Add member to a group::
 524 signal-cli -u USERNAME updateGroup -g GROUP_ID -m "NEW_MEMBER"
 525
 526 Accept a group invitation::
 527 signal-cli -u USERNAME updateGroup -g GROUP_ID
 528
 529 Leave a group::
 530 signal-cli -u USERNAME quitGroup -g GROUP_ID
 531
 532 Send a message to a group::
 533 signal-cli -u USERNAME send -m "This is a message" -g GROUP_ID
 534
 535 Trust new key, after having verified it::
 536 signal-cli -u USERNAME trust -v SAFETY_NUMBER NUMBER
 537
 538 Trust new key, without having verified it. Only use this if you don't care about security::
 539 signal-cli -u USERNAME trust -a NUMBER
 540
 541 == Exit codes
 542 * *1*: Error is probably caused and fixable by the user
 543 * *2*: Some unexpected error
 544 * *3*: Server or IO error
 545 * *4*: Sending failed due to untrusted key
 546
 547 == Files
 548
 549 The password and cryptographic keys are created when registering and stored in the current users home directory, the directory can be changed with *--config*:
 550
 551 `$XDG_DATA_HOME/signal-cli/` (`$HOME/.local/share/signal-cli/`)
 552
 553 == Authors
 554
 555 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
 556 For more information about signal-cli development, see
 557 <https://github.com/AsamK/signal-cli>.