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