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