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