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