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