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