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