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 *--view-once*::
 320 Send the message as a view once message.
 321 A conformant client will only allow the receiver to view the message once.
 322 View Once is only supported for messages that include an image attachment.
 323
 324 *--sticker* STICKER::
 325 Send a sticker of a locally known sticker pack (syntax: stickerPackId:stickerId).
 326 Shouldn't be used together with `-m` as the official clients don't support this.
 327 e.g.: `--sticker 00abac3bc18d7f599bff2325dc306d43:2`
 328
 329 *--mention*::
 330 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.
 331 The units of start and length should be UTF-16 code units, NOT Unicode code points.
 332 For more information, see https://github.com/AsamK/signal-cli/wiki/FAQ#string-indexing-units
 333 e.g.: `-m "Hi X!" --mention "3:1:+123456789"`
 334
 335 *--text-style*::
 336 Style parts of the message text (syntax: start:length:STYLE).
 337 Like `--mention`, the units are UTF-16 code units.
 338 Where STYLE is one of: BOLD, ITALIC, SPOILER, STRIKETHROUGH, MONOSPACE
 339
 340 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"`
 341
 342 *--quote-timestamp*::
 343 Specify the timestamp of a previous message with the recipient or group to add a quote to the new message.
 344
 345 *--quote-author*::
 346 Specify the author of the original message.
 347
 348 *--quote-message*::
 349 Specify the message of the original message.
 350
 351 *--quote-mention*::
 352 Specify the mentions of the original message (same format as `--mention`).
 353
 354 *--quote-text-style*::
 355 Style parts of the original message text (same format as `--text-style`).
 356
 357 *--quote-attachment*::
 358 Specify the attachments of the original message (syntax: contentType[:filename[:previewFile]]), e.g. 'audio/aac' or 'image/png:test.png:/tmp/preview.jpg'.
 359
 360 *--preview-url*::
 361 Specify the url for the link preview.
 362 The same url must also appear in the message body, otherwise the preview won't be displayed by the apps.
 363
 364 *--preview-title*::
 365 Specify the title for the link preview (mandatory).
 366
 367 *--preview-description*::
 368 Specify the description for the link preview (optional).
 369
 370 *--preview-image*::
 371 Specify the image file for the link preview (optional).
 372
 373 *--story-timestamp*::
 374 Specify the timestamp of a story to reply to.
 375
 376 *--story-author*::
 377 Specify the author of the story.
 378
 379 *-e*, *--end-session*::
 380 Clear session state and send end session message.
 381
 382 *--edit-timestamp*::
 383 Specify the timestamp of a previous message with the recipient or group to send an edited message.
 384
 385 === sendMessageRequestResponse
 386
 387 Send response to a message request to linked devices.
 388
 389 RECIPIENT::
 390 Specify the recipients.
 391
 392 *-g* GROUP, *--group-id* GROUP::
 393 Specify the recipient group ID in base64 encoding.
 394
 395 *-u* USERNAME, *--username* USERNAME::
 396 Specify the recipient username or username link.
 397
 398 *--type* TYPE::
 399 Type of message request response (accept, delete)
 400
 401 === sendPaymentNotification
 402
 403 Send a payment notification.
 404
 405 RECIPIENT::
 406 Specify the recipient.
 407
 408 *--receipt* RECEIPT::
 409 The base64 encoded receipt blob.
 410
 411 *--note* NOTE::
 412 Specify a note for the payment notification.
 413
 414 === sendReaction
 415
 416 Send reaction to a previously received or sent message.
 417
 418 RECIPIENT::
 419 Specify the recipients.
 420
 421 *-g* GROUP, *--group-id* GROUP::
 422 Specify the recipient group ID in base64 encoding.
 423
 424 *-u* USERNAME, *--username* USERNAME::
 425 Specify the recipient username or username link.
 426
 427 *-e* EMOJI, *--emoji* EMOJI::
 428 Specify the emoji, should be a single unicode grapheme cluster.
 429
 430 *-a* RECIPIENT, *--target-author* RECIPIENT::
 431 Specify the author of the message to which to react.
 432
 433 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
 434 Specify the timestamp of the message to which to react.
 435
 436 *-r*, *--remove*::
 437 Remove a reaction.
 438
 439 *--story*::
 440 React to a story instead of a normal message
 441
 442 === sendReceipt
 443
 444 Send a read or viewed receipt to a previously received message.
 445
 446 RECIPIENT::
 447 Specify the sender.
 448
 449 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
 450 Specify the timestamp of the message to which to react.
 451
 452 *--type* TYPE::
 453 Specify the receipt type, either `read` (the default) or `viewed`.
 454
 455 === sendTyping
 456
 457 Send typing message to trigger a typing indicator for the recipient.
 458 Indicator will be shown for 15seconds unless a typing STOP message is sent first.
 459
 460 RECIPIENT::
 461 Specify the recipients.
 462
 463 *-g* GROUP, *--group-id* GROUP::
 464 Specify the recipient group ID in base64 encoding.
 465
 466 *-s*, *--stop*::
 467 Send a typing STOP message.
 468
 469 === remoteDelete
 470
 471 Remotely delete a previously sent message.
 472
 473 RECIPIENT::
 474 Specify the recipients.
 475
 476 *-g* GROUP, *--group-id* GROUP::
 477 Specify the recipient group ID in base64 encoding.
 478
 479 *-u* USERNAME, *--username* USERNAME::
 480 Specify the recipient username or username link.
 481
 482 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
 483 Specify the timestamp of the message to delete.
 484
 485 === receive
 486
 487 Query the server for new messages.
 488 New messages are printed on standard output and attachments are downloaded to the config directory.
 489 In json mode this is outputted as one json object per line.
 490
 491 *-t* TIMEOUT, *--timeout* TIMEOUT::
 492 Number of seconds to wait for new messages (negative values disable timeout).
 493 Default is 5 seconds.
 494
 495 *--max-messages*::
 496 Maximum number of messages to receive, before returning.
 497
 498 *--ignore-attachments*::
 499 Don’t download attachments of received messages.
 500
 501 *--ignore-stories*::
 502 Don’t receive story messages from the server.
 503
 504
 505 *--send-read-receipts*::
 506 Send read receipts for all incoming data messages (in addition to the default delivery receipts)
 507
 508 === joinGroup
 509
 510 Join a group via an invitation link.
 511
 512 *--uri*::
 513 The invitation link URI (starts with `https://signal.group/#`)
 514
 515 === updateGroup
 516
 517 Create or update a group.
 518 If the user is a pending member, this command will accept the group invitation.
 519
 520 *-g* GROUP, *--group-id* GROUP::
 521 Specify the recipient group ID in base64 encoding.
 522 If not specified, a new group with a new random ID is generated.
 523
 524 *-n* NAME, *--name* NAME::
 525 Specify the new group name.
 526
 527 *-d* DESCRIPTION, *--description* DESCRIPTION::
 528 Specify the new group description.
 529
 530 *-a* AVATAR, *--avatar* AVATAR::
 531 Specify a new group avatar image file.
 532
 533 *-m* [MEMBER [MEMBER ...]], *--member* [MEMBER [MEMBER ...]]::
 534 Specify one or more members to add to the group.
 535
 536 *-r* [MEMBER [MEMBER ...]], *--remove-member* [MEMBER [MEMBER ...]]::
 537 Specify one or more members to remove from the group
 538
 539 *--admin* [MEMBER [MEMBER ...]]::
 540 Specify one or more members to make a group admin
 541
 542 *--remove-admin* [MEMBER [MEMBER ...]]::
 543 Specify one or more members to remove group admin privileges
 544
 545 *--ban* [MEMBER [MEMBER ...]]::
 546 Specify one or more members to ban from joining the group.
 547 Banned members cannot join or request to join via a group link.
 548
 549 *--unban* [MEMBER [MEMBER ...]]::
 550 Specify one or more members to remove from the ban list
 551
 552 *--reset-link*::
 553 Reset group link and create new link password
 554
 555 *--link* LINK_STATE::
 556 Set group link state: `enabled`, `enabled-with-approval`, `disabled`
 557
 558 *--set-permission-add-member* PERMISSION::
 559 Set permission to add new group members: `every-member`, `only-admins`
 560
 561 *--set-permission-edit-details* PERMISSION::
 562 Set permission to edit group details: `every-member`, `only-admins`
 563
 564 *--set-permission-send-messages* PERMISSION::
 565 Set permission to send messages in group: `every-member`, `only-admins`
 566 Groups where only admins can send messages are also called announcement groups
 567
 568 *-e* EXPIRATION_SECONDS, *--expiration* EXPIRATION_SECONDS::
 569 Set expiration time of messages (seconds).
 570 To disable expiration set expiration time to 0.
 571
 572 === quitGroup
 573
 574 Send a quit group message to all group members and remove self from member list.
 575 If the user is a pending member, this command will decline the group invitation.
 576
 577 *-g* GROUP, *--group-id* GROUP::
 578 Specify the recipient group ID in base64 encoding.
 579
 580 *--delete*::
 581 Delete local group data completely after quitting group.
 582
 583 === listGroups
 584
 585 Show a list of known groups and related information.
 586 In json mode this is outputted as an list of objects and is always in detailed mode.
 587
 588 *-d*, *--detailed*::
 589 Include the list of members of each group and the group invite link.
 590
 591 *-g*, *--group-id*::
 592 Filter the group list by one or more group IDs.
 593
 594 === listContacts
 595
 596 Show a list of known contacts with names and profiles.
 597 When a specific recipient is given, its profile will be refreshed.
 598
 599 RECIPIENT::
 600 Specify the recipients.
 601
 602 *-a*, *--all-recipients*::
 603 Include all known recipients, not only contacts.
 604
 605 *--blocked*::
 606 Specify if only blocked or unblocked contacts should be shown (default: all contacts)
 607
 608 *--name*::
 609 Find contacts with the given contact or profile name.
 610
 611 *--detailed*::
 612 List the contacts with more details.
 613 If output=json, then this is always set
 614
 615 *--internal*::
 616 Include internal information that's normally not user visible
 617
 618 === listIdentities
 619
 620 List all known identity keys and their trust status, fingerprint and safety number.
 621
 622 *-n* RECIPIENT, *--number* RECIPIENT::
 623 Only show identity keys for the given recipient.
 624
 625 === trust
 626
 627 Set the trust level of a given recipient.
 628 The first time a key for a recipient is seen, it is trusted by default (TOFU).
 629 If the key changes, the new key must be trusted manually.
 630
 631 RECIPIENT::
 632 Specify the recipient, for which to set the trust.
 633
 634 *-a*, *--trust-all-known-keys*::
 635 Trust all known keys of this user, only use this for testing.
 636
 637 *-v* VERIFIED_SAFETY_NUMBER, *--verified-safety-number* VERIFIED_SAFETY_NUMBER::
 638 Specify the safety number of the key, only use this option if you have verified the safety number.
 639 Can be either the plain text numbers shown in the app or the bytes from the QR-code, encoded as base64.
 640
 641 === updateProfile
 642
 643 Update the profile information shown to message recipients.
 644 The profile is stored encrypted on the Signal servers.
 645 The decryption key is sent with every outgoing messages to contacts and included in every group.
 646
 647 *--given-name* NAME, *--name* NAME::
 648 New (given) name.
 649
 650 *--family-name* FAMILY_NAME::
 651 New family name.
 652
 653 *--about* ABOUT_TEXT::
 654 New profile status text.
 655
 656 *--about-emoji* EMOJI::
 657 New profile status emoji.
 658
 659 *--avatar* AVATAR_FILE::
 660 Path to the new avatar image file.
 661
 662 *--remove-avatar*::
 663 Remove the avatar
 664
 665 *--mobile-coin-address*, **--mobilecoin-address**::
 666 New MobileCoin address (Base64 encoded public address)
 667
 668 === updateContact
 669
 670 Update the info associated to a recipient on our contact list.
 671 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 672 If the contact doesn't exist yet, it will be added.
 673
 674 RECIPIENT::
 675 Specify the recipient.
 676
 677 *--given-name* GIVEN_NAME, *--name* NAME::
 678 New system given name.
 679
 680 *--family-name* FAMILY_NAME::
 681 New system family name.
 682
 683 *--nick-given-name* NICK_GIVEN_NAME::
 684 New nick given name.
 685
 686 *--nick-family-name* NICK_FAMILY_NAME::
 687 New nick family name.
 688
 689 *--note* NOTE::
 690 New note.
 691
 692 *-e*, *--expiration* EXPIRATION_SECONDS::
 693 Set expiration time of messages (seconds).
 694 To disable expiration set expiration time to 0.
 695
 696 === removeContact
 697
 698 Remove the info of a given contact
 699
 700 RECIPIENT::
 701 Specify the recipient.
 702
 703 *--hide*::
 704 Hide the contact in the contact list, but keep the data.
 705
 706 *--forget*::
 707 Delete all data associated with this contact, including identity keys and sessions.
 708
 709 === block
 710
 711 Block the given contacts or groups (no messages will be received).
 712 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 713
 714 [RECIPIENT [RECIPIENT ...]]::
 715 Specify the contacts that should be blocked.
 716
 717 *-g* [GROUP [GROUP ...]], *--group-id* [GROUP [GROUP ...]]::
 718 Specify the group IDs that should be blocked in base64 encoding.
 719
 720 === unblock
 721
 722 Unblock the given contacts or groups (messages will be received again).
 723 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 724
 725 [RECIPIENT [RECIPIENT ...]]::
 726 Specify the contacts that should be unblocked.
 727
 728 *-g* [GROUP [GROUP ...]], *--group-id* [GROUP [GROUP ...]]::
 729 Specify the group IDs that should be unblocked in base64 encoding.
 730
 731 === sendContacts
 732
 733 Send a synchronization message with the local contacts list to all linked devices.
 734 This command should only be used if this is the primary device.
 735
 736 === sendSyncRequest
 737
 738 Send a synchronization request message to the primary device (for group, contacts, ...).
 739 The primary device will respond with synchronization messages with full contact and group lists.
 740
 741 === uploadStickerPack
 742
 743 Upload a new sticker pack, consisting of a manifest file and the sticker images. +
 744 Images must conform to the following specification: (see https://support.signal.org/hc/en-us/articles/360031836512-Stickers#sticker_reqs )
 745
 746 - Static stickers in PNG or WebP format
 747 - Animated stickers in APNG format,
 748 - Maximum file size for a sticker file is 300KiB
 749 - Image resolution of 512 x 512 px
 750
 751 The required manifest.json has the following format:
 752
 753 [source,json]
 754 ----
 755 {
 756   "title": "<STICKER_PACK_TITLE>",
 757   "author": "<STICKER_PACK_AUTHOR>",
 758   "cover": { // Optional cover, by default the first sticker is used as cover
 759     "file": "<name of image file, mandatory>",
 760     "contentType": "<optional>",
 761     "emoji": "<optional>"
 762   },
 763   "stickers": [
 764     {
 765       "file": "<name of image file, mandatory>",
 766       "contentType": "<optional>",
 767       "emoji": "<optional>"
 768     }
 769     ...
 770   ]
 771 }
 772 ----
 773
 774 PATH::
 775 The path of the manifest.json or a zip file containing the sticker pack you wish to upload.
 776
 777 === listStickerPacks
 778
 779 Show a list of known sticker packs.
 780
 781 === addStickerPack
 782
 783 Install a sticker pack for this account.
 784
 785 *--uri* [URI]::
 786 Specify the uri of the sticker pack.
 787 e.g. https://signal.art/addstickers/#pack_id=XXX&pack_key=XXX
 788
 789 === getAttachment
 790
 791 Gets the raw data for a specified attachment.
 792 This is done using the ID of the attachment the recipient or group ID.
 793 The attachment data is returned as a Base64 String.
 794
 795 *--id* [ID]::
 796 The ID of the attachment as given in the attachment list of the message.
 797
 798 *--recipient* [RECIPIENT]::
 799 Specify the recipient which sent the attachment.
 800 Referred to generally as recipient.
 801
 802 *-g* [GROUP], *--group-id* [GROUP]::
 803 Alternatively, specify the group IDs for which to get the attachment.
 804
 805 === getAvatar
 806
 807 Gets the raw data for a specified contact, contact's profile or group avatar.
 808 The attachment data is returned as a Base64 String.
 809
 810 *--contact* [RECIPIENT]::
 811 Specify the recipient.
 812
 813 *--profile* [RECIPIENT]::
 814 Specify the recipient.
 815
 816 *-g* [GROUP], *--group-id* [GROUP]::
 817 Alternatively, specify the group ID for which to get the avatar.
 818
 819 === getSticker
 820
 821 Gets the raw data for a specified sticker.
 822 The attachment data is returned as a Base64 String.
 823
 824 *--pack-id* [PACK_ID]::
 825 Specify the id of a sticker pack (hex encoded).
 826
 827 *--sticker-id* [STICKER_ID]::
 828 Specify the index of a sticker in the sticker pack.
 829
 830 === daemon
 831
 832 signal-cli can run in daemon mode and provides JSON-RPC or an experimental dbus interface.
 833 If no `-a` account is given, all local accounts will be loaded.
 834 Multiple interfaces can be used at the same time, e.g. `daemon --socket --dbus`
 835
 836 *--socket [SOCKET]*::
 837 Export a JSON-RPC interface on a UNIX socket (default $XDG_RUNTIME_DIR/signal-cli/socket). +
 838 See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
 839
 840 *--tcp [HOST:PORT]*::
 841 Export a JSON-RPC interface on a TCP socket (default localhost:7583). +
 842 See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
 843
 844 *--http [HOST:PORT]*::
 845 Expose a JSON-RPC interface as http endpoint (default localhost:8080).
 846 The JSON-RPC endpoint is `/api/v1/rpc`. +
 847 See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
 848
 849 *--dbus*::
 850 Export DBus interface on user bus. +
 851 See **signal-cli-dbus**(5) for info on the dbus interface.
 852
 853 *--dbus-system*::
 854 Export DBus interface on system bus. +
 855 See **signal-cli-dbus**(5) for info on the dbus interface.
 856
 857 *--bus-name*::
 858 Claim another D-Bus bus name than the default.
 859
 860 *--ignore-attachments*::
 861 Don’t download attachments of received messages.
 862
 863 *--ignore-stories*::
 864 Don’t receive story messages from the server.
 865
 866 *--send-read-receipts*::
 867 Send read receipts for all incoming data messages (in addition to the default delivery receipts)
 868
 869 *--no-receive-stdout*::
 870 Don’t print received messages to stdout.
 871
 872 *--receive-mode*::
 873 Specify when to start receiving messages (on-start, on-connection, manual)
 874
 875 === jsonRpc
 876
 877 Run in signal-cli in JSON-RPC mode.
 878 Reads JSON-RPC requests on stdin and responds on stdout.
 879 See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
 880
 881 *--ignore-attachments*::
 882 Don’t download attachments of received messages.
 883
 884 *--ignore-stories*::
 885 Don’t receive story messages from the server.
 886
 887 *--send-read-receipts*::
 888 Send read receipts for all incoming data messages (in addition to the default delivery receipts)
 889
 890 *--receive-mode*::
 891 Specify when to start receiving messages (on-start, manual)
 892
 893 === submitRateLimitChallenge
 894
 895 When running into rate limits, sometimes the limit can be lifted, by solving a CAPTCHA.
 896 To get the captcha token, go to https://signalcaptchas.org/challenge/generate.html
 897 For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html
 898
 899 *--challenge* CHALLENGE_TOKEN::
 900 The challenge token from the failed send attempt.
 901
 902 *--captcha* CAPTCHA::
 903 The captcha result, starting with signalcaptcha://
 904
 905 == Examples
 906
 907 Register a number (with SMS verification)::
 908 signal-cli -a ACCOUNT register
 909
 910 Verify the number using the code received via SMS or voice::
 911 signal-cli -a ACCOUNT verify CODE
 912
 913 Send a message to one or more recipients::
 914 signal-cli -a ACCOUNT send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
 915
 916 Pipe the message content from another process::
 917 uname -a | signal-cli -a ACCOUNT send --message-from-stdin [RECIPIENT [RECIPIENT ...]]
 918
 919 Create a group::
 920 signal-cli -a ACCOUNT updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
 921
 922 Add member to a group::
 923 signal-cli -a ACCOUNT updateGroup -g GROUP_ID -m "NEW_MEMBER"
 924
 925 Accept a group invitation::
 926 signal-cli -a ACCOUNT updateGroup -g GROUP_ID
 927
 928 Leave a group::
 929 signal-cli -a ACCOUNT quitGroup -g GROUP_ID
 930
 931 Send a message to a group::
 932 signal-cli -a ACCOUNT send -m "This is a message" -g GROUP_ID
 933
 934 Trust new key, after having verified it::
 935 signal-cli -a ACCOUNT trust -v SAFETY_NUMBER RECIPIENT
 936
 937 Trust new key, without having verified it. Only use this if you don't care about security::
 938 signal-cli -a ACCOUNT trust -a RECIPIENT
 939
 940 == Exit codes
 941
 942 * *1*: Error is probably caused and fixable by the user
 943 * *2*: Some unexpected error
 944 * *3*: Server or IO error
 945 * *4*: Sending failed due to untrusted key
 946 * *5*: Server rate limiting error
 947
 948 == Files
 949
 950 The password and cryptographic keys are created when registering and stored in the current users home directory, the directory can be changed with *--config*:
 951
 952 `$XDG_DATA_HOME/signal-cli/` (`$HOME/.local/share/signal-cli/`)
 953
 954 == Authors
 955
 956 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
 957 For more information about signal-cli development, see
 958 <https://github.com/AsamK/signal-cli>.