nmode's Git Repositories - signal-cli/blob - man/signal-cli.1.adoc

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