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