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
   5 :quotes.~:
   6
   7 = signal-cli (1)
   8 :doctype: manpage
   9
  10 == Name
  11
  12 signal-cli - A commandline interface for the Signal messenger
  13
  14 == Synopsis
  15
  16 *signal-cli* [--config CONFIG] [-h | -v | -a ACCOUNT | --dbus | --dbus-system] command [command-options]
  17
  18 == Description
  19
  20 signal-cli is a commandline interface for libsignal-service-java.
  21 It supports registering, verifying, sending and receiving messages.
  22 For registering you need a phone number where you can receive SMS or incoming calls.
  23 signal-cli was primarily developed to be used on servers to notify admins of important events.
  24 For this use-case, it has a dbus and a JSON-RPC interface, that can be used to send messages from other programs.
  25
  26 For some functionality the Signal protocol requires that all messages have been received from the server.
  27 The `receive` command should be regularly executed.
  28 In daemon mode messages are by default continuously received.
  29
  30 == Options
  31
  32 *-h*, *--help*::
  33 Show help message and quit.
  34
  35 *--version*::
  36 Print the version and quit.
  37
  38 *-v*, *--verbose*::
  39 Raise log level and include lib signal logs.
  40
  41 *--log-file* LOG_FILE::
  42 Write log output to the given file.
  43 If `--verbose` is also given, the detailed logs will only be written to the log file.
  44
  45 *--scrub-log*::
  46 Scrub possibly sensitive information from the log, like phone numbers and UUIDs.
  47 Doesn't work reliably on dbus logs with very verbose logging (`-vvv`)
  48
  49 *--config* CONFIG::
  50 Set the path, where to store the config.
  51 Make sure you have full read/write access to the given directory.
  52 (Default: `$XDG_DATA_HOME/signal-cli` (`$HOME/.local/share/signal-cli`))
  53
  54 *-a* ACCOUNT, *--account* ACCOUNT::
  55 Specify your phone number, that will be your identifier.
  56 The phone number must include the country calling code, i.e. the number must start with a "+" sign.
  57
  58 This flag must not be given for the `link` command.
  59 It is optional for the `daemon` command.
  60 For all other commands it is only optional if there is exactly one local user in the config directory.
  61
  62 *--service-environment* ENVIRONMENT::
  63 Choose the server environment to use:
  64
  65 - `live` (default)
  66 - `staging`
  67
  68 *--dbus*::
  69 Make request via user dbus.
  70
  71 *--dbus-system*::
  72 Make request via system dbus.
  73
  74 *--bus-name*::
  75 Connect to another D-Bus bus name than the default.
  76
  77 *-o* OUTPUT-MODE, *--output* OUTPUT-MODE::
  78 Specify if you want commands to output in either "plain-text" mode or in "json".
  79 Defaults to "plain-text"
  80
  81 *--trust-new-identities* TRUST-MODE::
  82 Choose when to trust new identities:
  83 - `on-first-use` (default): Trust the first seen identity key from new users, changed keys must be verified manually
  84 - `always`: Trust any new identity key without verification
  85 - `never`: Don't trust any unknown identity key, every key must be verified manually
  86
  87 *--disable-send-log*::
  88 Disable message send log (for resending messages that recipient couldn't decrypt).
  89
  90 == Commands
  91
  92 === register
  93
  94 Register a phone number with SMS or voice verification.
  95 Use the verify command to complete the verification.
  96
  97 If the account is just deactivated, the register command will just reactivate account, without requiring an SMS verification.
  98 By default the unregister command just deactivates the account, in which case it can be reactivated without sms verification if the local data is still available.
  99 If the account was deleted (with --delete-account) it cannot be reactivated.
 100
 101 *-v*, *--voice*::
 102 The verification should be done over voice, not SMS.
 103 Voice verification only works if an SMS verification has been attempted before.
 104
 105 *--captcha*::
 106 The captcha token, required if registration failed with a captcha required error.
 107 To get the token, go to https://signalcaptchas.org/registration/generate.html
 108 For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html
 109 After solving the captcha, right-click on the "Open Signal" link and copy the link.
 110
 111 === verify
 112
 113 Verify the number using the code received via SMS or voice.
 114
 115 VERIFICATIONCODE::
 116 The verification code.
 117
 118 *-p* PIN, *--pin* PIN::
 119 The registration lock PIN, that was set by the user.
 120 Only required if a PIN was set.
 121
 122 === unregister
 123
 124 Disable push support for this device, i.e. this device won't receive any more messages.
 125 If this is the primary device, other users can't send messages to this number anymore.
 126 Use "updateAccount" to undo this.
 127 To remove a linked device, use "removeDevice" from the primary device.
 128
 129 *--delete-account*::
 130 Delete account completely from server.
 131 Cannot be undone without loss.
 132 You will have to be readded to each group.
 133
 134 CAUTION: Only delete your account if you won't use this number again!
 135
 136 === deleteLocalAccountData
 137
 138 Delete all local data for this account.
 139 Data should only be deleted if the account is unregistered.
 140
 141 CAUTION: This cannot be undone.
 142
 143 *--ignore-registered*::
 144 Delete the account data even though the account is still registered on the Signal servers.
 145
 146 === updateAccount
 147
 148 Update the account attributes on the signal server.
 149 Can fix problems with receiving messages.
 150
 151 *-n* NAME, *--device-name* NAME::
 152 Set a new device name for the primary or linked device
 153
 154 *--unrestricted-unidentified-sender* {true,false}::
 155 Enable if anyone should be able to send you unidentified sender messages.
 156
 157 *--discoverable-by-number* {true,false}::
 158 Enable/disable if the account should be discoverable by phone number
 159
 160 *--number-sharing* {true,false}::
 161 Indicates if Signal should share its phone number when sending a message.
 162
 163 === startChangeNumber
 164
 165 Change an account to a new phone number with SMS or voice verification.
 166 Use the finishChangeNumber command to complete the verification.
 167
 168 NUMBER::
 169 The new phone number.
 170
 171 *-v*, *--voice*::
 172 The verification should be done over voice, not SMS.
 173 Voice verification only works if an SMS verification has been attempted before.
 174
 175 *--captcha*::
 176 The captcha token, required if registration failed with a captcha required error.
 177 To get the token, go to https://signalcaptchas.org/registration/generate.html
 178 For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html
 179 After solving the captcha, right-click on the "Open Signal" link and copy the link.
 180
 181 === finishChangeNumber
 182
 183 Verify the number using the code received via SMS or voice.
 184
 185 NUMBER::
 186 The new phone number.
 187
 188 *-v*, *--verification-code*::
 189 The verification code.
 190
 191 *-p* PIN, *--pin* PIN::
 192 The registration lock PIN, that was set by the user.
 193 Only required if a PIN was set.
 194
 195 === updateConfiguration
 196
 197 Update signal configs and sync them to linked devices.
 198 This command only works on the primary devices.
 199
 200 *--read-receipts* {true,false}::
 201 Indicates if Signal should send read receipts.
 202
 203 *--unidentified-delivery-indicators* {true,false}::
 204 Indicates if Signal should show unidentified delivery indicators.
 205
 206 *--typing-indicators* {true,false}::
 207 Indicates if Signal should send/show typing indicators.
 208
 209 *--link-previews* {true,false}::
 210 Indicates if Signal should generate link previews.
 211
 212 === setPin
 213
 214 Set a registration lock pin, to prevent others from registering this number.
 215
 216 REGISTRATION_LOCK_PIN::
 217 The registration lock PIN, that will be required for new registrations (resets after 7 days of inactivity)
 218
 219 === removePin
 220
 221 Remove the registration lock pin.
 222
 223 === link
 224
 225 Link to an existing device, instead of registering a new number.
 226 This shows a "sgnl://linkdevice?uuid=..." URI.
 227 If you want to connect to another signal-cli instance, you can just use this URI.
 228 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.
 229
 230 *-n* NAME, *--name* NAME::
 231 Optionally specify a name to describe this new device.
 232 By default "cli" will be used.
 233
 234 === addDevice
 235
 236 Link another device to this device.
 237 Only works, if this is the primary device.
 238
 239 *--uri* URI::
 240 Specify the uri contained in the QR code shown by the new device.
 241 You will need the full URI such as "sgnl://linkdevice?uuid=..." (formerly "tsdevice:/?uuid=...") Make sure to enclose it in quotation marks for shells.
 242
 243 === listDevices
 244
 245 Show a list of linked devices.
 246
 247 === removeDevice
 248
 249 Remove a linked device.
 250 Only works, if this is the primary device.
 251
 252 *-d* DEVICE_ID, *--device-id* DEVICE_ID::
 253 Specify the device you want to remove.
 254 Use listDevices to see the deviceIds.
 255
 256 === getUserStatus
 257
 258 Uses a list of phone numbers to determine the statuses of those users.
 259 Shows if they are registered on the Signal Servers or not.
 260 In json mode this is outputted as a list of objects.
 261
 262 [NUMBER [NUMBER ...]]::
 263 One or more numbers to check.
 264
 265 === send
 266
 267 Send a message to another user or group.
 268
 269 RECIPIENT::
 270 Specify the recipients’ phone number.
 271
 272 *--note-to-self*::
 273 Send the message to self without notification.
 274
 275 *-g* GROUP, *--group-id* GROUP::
 276 Specify the recipient group ID in base64 encoding.
 277
 278 *-m* MESSAGE, *--message* MESSAGE::
 279 Specify the message.
 280
 281 *--message-from-stdin*::
 282 Read the message from standard input.
 283
 284 *-a* [ATTACHMENT [ATTACHMENT ...]], *--attachment* [ATTACHMENT [ATTACHMENT ...]]::
 285 Add one or more files as attachment.
 286 Can be either a file path or a data URI.
 287 Data URI encoded attachments must follow the RFC 2397.
 288 Additionally a file name can be added:
 289 e.g.: `data:<MIME-TYPE>;filename=<FILENAME>;base64,<BASE64 ENCODED DATA>`
 290
 291 *--sticker* STICKER::
 292 Send a sticker of a locally known sticker pack (syntax: stickerPackId:stickerId).
 293 Shouldn't be used together with `-m` as the official clients don't support this.
 294 e.g.: `--sticker 00abac3bc18d7f599bff2325dc306d43:2`
 295
 296 *--mention*::
 297 Mention another group member (syntax: start:length:recipientNumber) In the apps the mention replaces part of the message text, which is specified by the start and length values.
 298 e.g.: `-m "Hi X!" --mention "3:1:+123456789"`
 299
 300 *--text-style*::
 301 Style parts of the message text (syntax: start:length:STYLE).
 302 Where STYLE is one of: BOLD, ITALIC, SPOILER, STRIKETHROUGH, MONOSPACE
 303
 304 e.g.: `-m "Something BIG!" --text-style "10:3:BOLD"` or for a mixed text style `-m "Something BIG!" --text-style "0:9:ITALIC" "10:3:BOLD"`
 305
 306 *--quote-timestamp*::
 307 Specify the timestamp of a previous message with the recipient or group to add a quote to the new message.
 308
 309 *--quote-author*::
 310 Specify the number of the author of the original message.
 311
 312 *--quote-message*::
 313 Specify the message of the original message.
 314
 315 *--quote-mention*::
 316 Specify the mentions of the original message (same format as `--mention`).
 317
 318 *--quote-text-style*::
 319 Style parts of the original message text (same format as `--text-style`).
 320
 321 *--quote-attachment*::
 322 Specify the attachments of the original message (syntax: contentType[:filename[:previewFile]]), e.g. 'audio/aac' or 'image/png:test.png:/tmp/preview.jpg'.
 323
 324 *--preview-url*::
 325 Specify the url for the link preview.
 326 The same url must also appear in the message body, otherwise the preview won't be displayed by the apps.
 327
 328 *--preview-title*::
 329 Specify the title for the link preview (mandatory).
 330
 331 *--preview-description*::
 332 Specify the description for the link preview (optional).
 333
 334 *--preview-image*::
 335 Specify the image file for the link preview (optional).
 336
 337 *--story-timestamp*::
 338 Specify the timestamp of a story to reply to.
 339
 340 *--story-author*::
 341 Specify the number of the author of the story.
 342
 343 *-e*, *--end-session*::
 344 Clear session state and send end session message.
 345
 346 *--edit-timestamp*::
 347 Specify the timestamp of a previous message with the recipient or group to send an edited message.
 348
 349 === sendMessageRequestResponse
 350
 351 Send response to a message request to linked devices.
 352
 353 RECIPIENT::
 354 Specify the recipients’ phone number.
 355
 356 *-g* GROUP, *--group-id* GROUP::
 357 Specify the recipient group ID in base64 encoding.
 358
 359 *--type* TYPE::
 360 Type of message request response (accept, delete)
 361
 362 === sendPaymentNotification
 363
 364 Send a payment notification.
 365
 366 RECIPIENT::
 367 Specify the recipient’s phone number.
 368
 369 *--receipt* RECEIPT::
 370 The base64 encoded receipt blob.
 371
 372 *--note* NOTE::
 373 Specify a note for the payment notification.
 374
 375 === sendReaction
 376
 377 Send reaction to a previously received or sent message.
 378
 379 RECIPIENT::
 380 Specify the recipients’ phone number.
 381
 382 *-g* GROUP, *--group-id* GROUP::
 383 Specify the recipient group ID in base64 encoding.
 384
 385 *-e* EMOJI, *--emoji* EMOJI::
 386 Specify the emoji, should be a single unicode grapheme cluster.
 387
 388 *-a* NUMBER, *--target-author* NUMBER::
 389 Specify the number of the author of the message to which to react.
 390
 391 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
 392 Specify the timestamp of the message to which to react.
 393
 394 *-r*, *--remove*::
 395 Remove a reaction.
 396
 397 *--story*::
 398 React to a story instead of a normal message
 399
 400 === sendReceipt
 401
 402 Send a read or viewed receipt to a previously received message.
 403
 404 RECIPIENT::
 405 Specify the sender’s phone number.
 406
 407 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
 408 Specify the timestamp of the message to which to react.
 409
 410 *--type* TYPE::
 411 Specify the receipt type, either `read` (the default) or `viewed`.
 412
 413 === sendTyping
 414
 415 Send typing message to trigger a typing indicator for the recipient.
 416 Indicator will be shown for 15seconds unless a typing STOP message is sent first.
 417
 418 RECIPIENT::
 419 Specify the recipients’ phone number.
 420
 421 *-g* GROUP, *--group-id* GROUP::
 422 Specify the recipient group ID in base64 encoding.
 423
 424 *-s*, *--stop*::
 425 Send a typing STOP message.
 426
 427 === remoteDelete
 428
 429 Remotely delete a previously sent message.
 430
 431 RECIPIENT::
 432 Specify the recipients’ phone number.
 433
 434 *-g* GROUP, *--group-id* GROUP::
 435 Specify the recipient group ID in base64 encoding.
 436
 437 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
 438 Specify the timestamp of the message to delete.
 439
 440 === receive
 441
 442 Query the server for new messages.
 443 New messages are printed on standard output and attachments are downloaded to the config directory.
 444 In json mode this is outputted as one json object per line.
 445
 446 *-t* TIMEOUT, *--timeout* TIMEOUT::
 447 Number of seconds to wait for new messages (negative values disable timeout).
 448 Default is 5 seconds.
 449
 450 *--max-messages*::
 451 Maximum number of messages to receive, before returning.
 452
 453 *--ignore-attachments*::
 454 Don’t download attachments of received messages.
 455
 456 *--ignore-stories*::
 457 Don’t receive story messages from the server.
 458
 459
 460 *--send-read-receipts*::
 461 Send read receipts for all incoming data messages (in addition to the default delivery receipts)
 462
 463 === joinGroup
 464
 465 Join a group via an invitation link.
 466
 467 *--uri*::
 468 The invitation link URI (starts with `https://signal.group/#`)
 469
 470 === updateGroup
 471
 472 Create or update a group.
 473 If the user is a pending member, this command will accept the group invitation.
 474
 475 *-g* GROUP, *--group-id* GROUP::
 476 Specify the recipient group ID in base64 encoding.
 477 If not specified, a new group with a new random ID is generated.
 478
 479 *-n* NAME, *--name* NAME::
 480 Specify the new group name.
 481
 482 *-d* DESCRIPTION, *--description* DESCRIPTION::
 483 Specify the new group description.
 484
 485 *-a* AVATAR, *--avatar* AVATAR::
 486 Specify a new group avatar image file.
 487
 488 *-m* [MEMBER [MEMBER ...]], *--member* [MEMBER [MEMBER ...]]::
 489 Specify one or more members to add to the group.
 490
 491 *-r* [MEMBER [MEMBER ...]], *--remove-member* [MEMBER [MEMBER ...]]::
 492 Specify one or more members to remove from the group
 493
 494 *--admin* [MEMBER [MEMBER ...]]::
 495 Specify one or more members to make a group admin
 496
 497 *--remove-admin* [MEMBER [MEMBER ...]]::
 498 Specify one or more members to remove group admin privileges
 499
 500 *--ban* [MEMBER [MEMBER ...]]::
 501 Specify one or more members to ban from joining the group.
 502 Banned members cannot join or request to join via a group link.
 503
 504 *--unban* [MEMBER [MEMBER ...]]::
 505 Specify one or more members to remove from the ban list
 506
 507 *--reset-link*::
 508 Reset group link and create new link password
 509
 510 *--link* LINK_STATE::
 511 Set group link state: `enabled`, `enabled-with-approval`, `disabled`
 512
 513 *--set-permission-add-member* PERMISSION::
 514 Set permission to add new group members: `every-member`, `only-admins`
 515
 516 *--set-permission-edit-details* PERMISSION::
 517 Set permission to edit group details: `every-member`, `only-admins`
 518
 519 *--set-permission-send-messages* PERMISSION::
 520 Set permission to send messages in group: `every-member`, `only-admins`
 521 Groups where only admins can send messages are also called announcement groups
 522
 523 *-e* EXPIRATION_SECONDS, *--expiration* EXPIRATION_SECONDS::
 524 Set expiration time of messages (seconds).
 525 To disable expiration set expiration time to 0.
 526
 527 === quitGroup
 528
 529 Send a quit group message to all group members and remove self from member list.
 530 If the user is a pending member, this command will decline the group invitation.
 531
 532 *-g* GROUP, *--group-id* GROUP::
 533 Specify the recipient group ID in base64 encoding.
 534
 535 *--delete*::
 536 Delete local group data completely after quitting group.
 537
 538 === listGroups
 539
 540 Show a list of known groups and related information.
 541 In json mode this is outputted as an list of objects and is always in detailed mode.
 542
 543 *-d*, *--detailed*::
 544 Include the list of members of each group and the group invite link.
 545
 546 *-g*, *--group-id*::
 547 Filter the group list by one or more group IDs.
 548
 549 === listContacts
 550
 551 Show a list of known contacts with names and profiles.
 552 When a specific recipient is given, its profile will be refreshed.
 553
 554 RECIPIENT::
 555 Specify the recipients’ phone number.
 556
 557 *-a*, *--all-recipients*::
 558 Include all known recipients, not only contacts.
 559
 560 *--blocked*::
 561 Specify if only blocked or unblocked contacts should be shown (default: all contacts)
 562
 563 *--name*::
 564 Find contacts with the given contact or profile name.
 565
 566 === listIdentities
 567
 568 List all known identity keys and their trust status, fingerprint and safety number.
 569
 570 *-n* NUMBER, *--number* NUMBER::
 571 Only show identity keys for the given phone number.
 572
 573 === trust
 574
 575 Set the trust level of a given number.
 576 The first time a key for a number is seen, it is trusted by default (TOFU).
 577 If the key changes, the new key must be trusted manually.
 578
 579 number::
 580 Specify the phone number, for which to set the trust.
 581
 582 *-a*, *--trust-all-known-keys*::
 583 Trust all known keys of this user, only use this for testing.
 584
 585 *-v* VERIFIED_SAFETY_NUMBER, *--verified-safety-number* VERIFIED_SAFETY_NUMBER::
 586 Specify the safety number of the key, only use this option if you have verified the safety number.
 587 Can be either the plain text numbers shown in the app or the bytes from the QR-code, encoded as base64.
 588
 589 === updateProfile
 590
 591 Update the profile information shown to message recipients.
 592 The profile is stored encrypted on the Signal servers.
 593 The decryption key is sent with every outgoing messages to contacts and included in every group.
 594
 595 *--given-name* NAME, *--name* NAME::
 596 New (given) name.
 597
 598 *--family-name* FAMILY_NAME::
 599 New family name.
 600
 601 *--about* ABOUT_TEXT::
 602 New profile status text.
 603
 604 *--about-emoji* EMOJI::
 605 New profile status emoji.
 606
 607 *--avatar* AVATAR_FILE::
 608 Path to the new avatar image file.
 609
 610 *--remove-avatar*::
 611 Remove the avatar
 612
 613 *--mobile-coin-address*::
 614 New MobileCoin address (Base64 encoded public address)
 615
 616 === updateContact
 617
 618 Update the info associated to a number on our contact list.
 619 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 620 If the contact doesn't exist yet, it will be added.
 621
 622 NUMBER::
 623 Specify the contact phone number.
 624
 625 *--given-name* NAME, *--name* NAME::
 626 New (given) name.
 627
 628 *--family-name* FAMILY_NAME::
 629 New family name.
 630
 631 *-e*, *--expiration* EXPIRATION_SECONDS::
 632 Set expiration time of messages (seconds).
 633 To disable expiration set expiration time to 0.
 634
 635 === removeContact
 636
 637 Remove the info of a given contact
 638
 639 NUMBER::
 640 Specify the contact phone number.
 641
 642 *--hide*::
 643 Hide the contact in the contact list, but keep the data.
 644
 645 *--forget*::
 646 Delete all data associated with this contact, including identity keys and sessions.
 647
 648 === block
 649
 650 Block the given contacts or groups (no messages will be received).
 651 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 652
 653 [CONTACT [CONTACT ...]]::
 654 Specify the phone numbers of contacts that should be blocked.
 655
 656 *-g* [GROUP [GROUP ...]], *--group-id* [GROUP [GROUP ...]]::
 657 Specify the group IDs that should be blocked in base64 encoding.
 658
 659 === unblock
 660
 661 Unblock the given contacts or groups (messages will be received again).
 662 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 663
 664 [CONTACT [CONTACT ...]]::
 665 Specify the phone numbers of contacts that should be unblocked.
 666
 667 *-g* [GROUP [GROUP ...]], *--group-id* [GROUP [GROUP ...]]::
 668 Specify the group IDs that should be unblocked in base64 encoding.
 669
 670 === sendContacts
 671
 672 Send a synchronization message with the local contacts list to all linked devices.
 673 This command should only be used if this is the primary device.
 674
 675 === sendSyncRequest
 676
 677 Send a synchronization request message to the primary device (for group, contacts, ...).
 678 The primary device will respond with synchronization messages with full contact and group lists.
 679
 680 === uploadStickerPack
 681
 682 Upload a new sticker pack, consisting of a manifest file and the sticker images. +
 683 Images must conform to the following specification: (see https://support.signal.org/hc/en-us/articles/360031836512-Stickers#sticker_reqs )
 684
 685 - Static stickers in PNG or WebP format
 686 - Animated stickers in APNG format,
 687 - Maximum file size for a sticker file is 300KiB
 688 - Image resolution of 512 x 512 px
 689
 690 The required manifest.json has the following format:
 691
 692 [source,json]
 693 ----
 694 {
 695   "title": "<STICKER_PACK_TITLE>",
 696   "author": "<STICKER_PACK_AUTHOR>",
 697   "cover": { // Optional cover, by default the first sticker is used as cover
 698     "file": "<name of image file, mandatory>",
 699     "contentType": "<optional>",
 700     "emoji": "<optional>"
 701   },
 702   "stickers": [
 703     {
 704       "file": "<name of image file, mandatory>",
 705       "contentType": "<optional>",
 706       "emoji": "<optional>"
 707     }
 708     ...
 709   ]
 710 }
 711 ----
 712
 713 PATH::
 714 The path of the manifest.json or a zip file containing the sticker pack you wish to upload.
 715
 716 === listStickerPacks
 717
 718 Show a list of known sticker packs.
 719
 720 === addStickerPack
 721
 722 Install a sticker pack for this account.
 723
 724 *--uri* [URI]::
 725 Specify the uri of the sticker pack.
 726 e.g. https://signal.art/addstickers/#pack_id=XXX&pack_key=XXX
 727
 728 === getAttachment
 729
 730 Gets the raw data for a specified attachment.
 731 This is done using the ID of the attachment the recipient or group ID.
 732 The attachment data is returned as a Base64 String.
 733
 734 *--id* [ID]::
 735 The ID of the attachment as given in the attachment list of the message.
 736
 737 *--recipient* [RECIPIENT]::
 738 Specify the number which sent the attachment.
 739 Referred to generally as recipient.
 740
 741 *-g* [GROUP], *--group-id* [GROUP]::
 742 Alternatively, specify the group IDs for which to get the attachment.
 743
 744 === getAvatar
 745
 746 Gets the raw data for a specified contact, contact's profile or group avatar.
 747 The attachment data is returned as a Base64 String.
 748
 749 *--contact* [RECIPIENT]::
 750 Specify the number of a recipient.
 751
 752 *--profile* [RECIPIENT]::
 753 Specify the number of a recipient.
 754
 755 *-g* [GROUP], *--group-id* [GROUP]::
 756 Alternatively, specify the group ID for which to get the avatar.
 757
 758 === getSticker
 759
 760 Gets the raw data for a specified sticker.
 761 The attachment data is returned as a Base64 String.
 762
 763 *--pack-id* [PACK_ID]::
 764 Specify the id of a sticker pack (hex encoded).
 765
 766 *--sticker-id* [STICKER_ID]::
 767 Specify the index of a sticker in the sticker pack.
 768
 769 === daemon
 770
 771 signal-cli can run in daemon mode and provides JSON-RPC or an experimental dbus interface.
 772 If no `-a` account is given, all local accounts will be loaded.
 773 Multiple interfaces can be used at the same time, e.g. `daemon --socket --dbus`
 774
 775 *--socket [SOCKET]*::
 776 Export a JSON-RPC interface on a UNIX socket (default $XDG_RUNTIME_DIR/signal-cli/socket). +
 777 See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
 778
 779 *--tcp [HOST:PORT]*::
 780 Export a JSON-RPC interface on a TCP socket (default localhost:7583). +
 781 See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
 782
 783 *--http [HOST:PORT]*::
 784 Expose a JSON-RPC interface as http endpoint (default localhost:8080).
 785 The JSON-RPC endpoint is `/api/v1/rpc`. +
 786 See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
 787
 788 *--dbus*::
 789 Export DBus interface on user bus. +
 790 See **signal-cli-dbus**(5) for info on the dbus interface.
 791
 792 *--dbus-system*::
 793 Export DBus interface on system bus. +
 794 See **signal-cli-dbus**(5) for info on the dbus interface.
 795
 796 *--bus-name*::
 797 Claim another D-Bus bus name than the default.
 798
 799 *--ignore-attachments*::
 800 Don’t download attachments of received messages.
 801
 802 *--ignore-stories*::
 803 Don’t receive story messages from the server.
 804
 805 *--send-read-receipts*::
 806 Send read receipts for all incoming data messages (in addition to the default delivery receipts)
 807
 808 *--no-receive-stdout*::
 809 Don’t print received messages to stdout.
 810
 811 *--receive-mode*::
 812 Specify when to start receiving messages (on-start, on-connection, manual)
 813
 814 === jsonRpc
 815
 816 Run in signal-cli in JSON-RPC mode.
 817 Reads JSON-RPC requests on stdin and responds on stdout.
 818 See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
 819
 820 *--ignore-attachments*::
 821 Don’t download attachments of received messages.
 822
 823 *--ignore-stories*::
 824 Don’t receive story messages from the server.
 825
 826 *--send-read-receipts*::
 827 Send read receipts for all incoming data messages (in addition to the default delivery receipts)
 828
 829 *--receive-mode*::
 830 Specify when to start receiving messages (on-start, manual)
 831
 832 === submitRateLimitChallenge
 833
 834 When running into rate limits, sometimes the limit can be lifted, by solving a CAPTCHA.
 835 To get the captcha token, go to https://signalcaptchas.org/challenge/generate.html
 836 For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html
 837
 838 *--challenge* CHALLENGE_TOKEN::
 839 The challenge token from the failed send attempt.
 840
 841 *--captcha* CAPTCHA::
 842 The captcha result, starting with signalcaptcha://
 843
 844 == Examples
 845
 846 Register a number (with SMS verification)::
 847 signal-cli -a ACCOUNT register
 848
 849 Verify the number using the code received via SMS or voice::
 850 signal-cli -a ACCOUNT verify CODE
 851
 852 Send a message to one or more recipients::
 853 signal-cli -a ACCOUNT send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
 854
 855 Pipe the message content from another process::
 856 uname -a | signal-cli -a ACCOUNT send --message-from-stdin [RECIPIENT [RECIPIENT ...]]
 857
 858 Create a group::
 859 signal-cli -a ACCOUNT updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
 860
 861 Add member to a group::
 862 signal-cli -a ACCOUNT updateGroup -g GROUP_ID -m "NEW_MEMBER"
 863
 864 Accept a group invitation::
 865 signal-cli -a ACCOUNT updateGroup -g GROUP_ID
 866
 867 Leave a group::
 868 signal-cli -a ACCOUNT quitGroup -g GROUP_ID
 869
 870 Send a message to a group::
 871 signal-cli -a ACCOUNT send -m "This is a message" -g GROUP_ID
 872
 873 Trust new key, after having verified it::
 874 signal-cli -a ACCOUNT trust -v SAFETY_NUMBER NUMBER
 875
 876 Trust new key, without having verified it. Only use this if you don't care about security::
 877 signal-cli -a ACCOUNT trust -a NUMBER
 878
 879 == Exit codes
 880
 881 * *1*: Error is probably caused and fixable by the user
 882 * *2*: Some unexpected error
 883 * *3*: Server or IO error
 884 * *4*: Sending failed due to untrusted key
 885 * *5*: Server rate limiting error
 886
 887 == Files
 888
 889 The password and cryptographic keys are created when registering and stored in the current users home directory, the directory can be changed with *--config*:
 890
 891 `$XDG_DATA_HOME/signal-cli/` (`$HOME/.local/share/signal-cli/`)
 892
 893 == Authors
 894
 895 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
 896 For more information about signal-cli development, see
 897 <https://github.com/AsamK/signal-cli>.