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