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