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