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
   9 == Name
  10
  11 signal-cli - A commandline interface for the Signal messenger
  12
  13 == Synopsis
  14
  15 *signal-cli* [--config CONFIG] [-h | -v | -a ACCOUNT | --dbus | --dbus-system] command [command-options]
  16
  17 == Description
  18
  19 signal-cli is a commandline interface for libsignal-service-java.
  20 It supports registering, verifying, sending and receiving messages.
  21 For registering you need a phone number where you can receive SMS or incoming calls.
  22 signal-cli was primarily developed to be used on servers to notify admins of important events.
  23 For this use-case, it has a dbus and a JSON-RPC interface, that can be used to send messages from other programs.
  24
  25 For some functionality the Signal protocol requires that all messages have been received from the server.
  26 The `receive` command should be regularly executed.
  27 In daemon mode messages are continuously received.
  28
  29 == Options
  30
  31 *-h*, *--help*::
  32 Show help message and quit.
  33
  34 *-v*, *--version*::
  35 Print the version and quit.
  36
  37 *--verbose*::
  38 Raise log level and include lib signal logs.
  39
  40 *--log-file* LOG_FILE::
  41 Write log output to the given file.
  42 If `--verbose` is also given, the detailed logs will only be written to the log file.
  43
  44 *--config* CONFIG::
  45 Set the path, where to store the config.
  46 Make sure you have full read/write access to the given directory.
  47 (Default: `$XDG_DATA_HOME/signal-cli` (`$HOME/.local/share/signal-cli`))
  48
  49 *-a* ACCOUNT, *--account* ACCOUNT::
  50 Specify your phone number, that will be your identifier.
  51 The phone number must include the country calling code, i.e. the number must start with a "+" sign.
  52
  53 This flag must not be given for the `link` command.
  54 It is optional for the `daemon` command.
  55 For all other commands it is only optional if there is exactly one local user in the config directory.
  56
  57 *--service-environment* ENVIRONMENT::
  58 Choose the server environment to use:
  59
  60 - `live` (default)
  61 - `staging`
  62
  63 *--dbus*::
  64 Make request via user dbus.
  65
  66 *--dbus-system*::
  67 Make request via system dbus.
  68
  69 *-o* OUTPUT-MODE, *--output* OUTPUT-MODE::
  70 Specify if you want commands to output in either "plain-text" mode or in "json".
  71 Defaults to "plain-text"
  72
  73 *--trust-new-identities* TRUST-MODE::
  74 Choose when to trust new identities:
  75 - `on-first-use` (default): Trust the first seen identity key from new users, changed keys must be verified manually
  76 - `always`: Trust any new identity key without verification
  77 - `never`: Don't trust any unknown identity key, every key must be verified manually
  78
  79 == Commands
  80
  81 === register
  82
  83 Register a phone number with SMS or voice verification.
  84 Use the verify command to complete the verification.
  85
  86 If the account is just deactivated, the register command will just reactivate account, without requiring an SMS verification.
  87 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.
  88 If the account was deleted (with --delete-account) it cannot be reactivated.
  89
  90 *-v*, *--voice*::
  91 The verification should be done over voice, not SMS.
  92
  93 *--captcha*::
  94 The captcha token, required if registration failed with a captcha required error.
  95 To get the token, go to https://signalcaptchas.org/registration/generate.html
  96 For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html
  97 Check the developer tools for a redirect starting with signalcaptcha:// Everything after signalcaptcha:// is the captcha token.
  98
  99 === verify
 100
 101 Verify the number using the code received via SMS or voice.
 102
 103 VERIFICATIONCODE::
 104 The verification code.
 105
 106 *-p* PIN, *--pin* PIN::
 107 The registration lock PIN, that was set by the user.
 108 Only required if a PIN was set.
 109
 110 === unregister
 111
 112 Disable push support for this device, i.e. this device won't receive any more messages.
 113 If this is the master device, other users can't send messages to this number anymore.
 114 Use "updateAccount" to undo this.
 115 To remove a linked device, use "removeDevice" from the master device.
 116
 117 *--delete-account*::
 118 Delete account completely from server.
 119 Cannot be undone without loss.
 120 You will have to be readded to each group.
 121
 122 CAUTION: Only delete your account if you won't use this number again!
 123
 124 === deleteLocalAccountData
 125
 126 Delete all local data for this account.
 127 Data should only be deleted if the account is unregistered.
 128
 129 CAUTION: This cannot be undone.
 130
 131 *--ignore-registered*::
 132 Delete the account data even though the account is still registered on the Signal servers.
 133
 134 === updateAccount
 135
 136 Update the account attributes on the signal server.
 137 Can fix problems with receiving messages.
 138
 139 *-n* NAME, *--device-name* NAME::
 140 Set a new device name for the main or linked device
 141
 142 === updateConfiguration
 143
 144 Update signal configs and sync them to linked devices.
 145 This command only works on the main devices.
 146
 147 *--read-receipts* {true,false}::
 148 Indicates if Signal should send read receipts.
 149
 150 *--unidentified-delivery-indicators* {true,false}::
 151 Indicates if Signal should show unidentified delivery indicators.
 152
 153 *--typing-indicators* {true,false}::
 154 Indicates if Signal should send/show typing indicators.
 155
 156 *--link-previews* {true,false}::
 157 Indicates if Signal should generate link previews.
 158
 159 === setPin
 160
 161 Set a registration lock pin, to prevent others from registering this number.
 162
 163 REGISTRATION_LOCK_PIN::
 164 The registration lock PIN, that will be required for new registrations (resets after 7 days of inactivity)
 165
 166 === removePin
 167
 168 Remove the registration lock pin.
 169
 170 === link
 171
 172 Link to an existing device, instead of registering a new number.
 173 This shows a "sgnl://linkdevice?uuid=..." URI.
 174 If you want to connect to another signal-cli instance, you can just use this URI.
 175 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.
 176
 177 *-n* NAME, *--name* NAME::
 178 Optionally specify a name to describe this new device.
 179 By default "cli" will be used.
 180
 181 === addDevice
 182
 183 Link another device to this device.
 184 Only works, if this is the master device.
 185
 186 *--uri* URI::
 187 Specify the uri contained in the QR code shown by the new device.
 188 You will need the full URI such as "sgnl://linkdevice?uuid=..." (formerly "tsdevice:/?uuid=...") Make sure to enclose it in quotation marks for shells.
 189
 190 === listDevices
 191
 192 Show a list of linked devices.
 193
 194 === removeDevice
 195
 196 Remove a linked device.
 197 Only works, if this is the master device.
 198
 199 *-d* DEVICE_ID, *--device-id* DEVICE_ID::
 200 Specify the device you want to remove.
 201 Use listDevices to see the deviceIds.
 202
 203 === getUserStatus
 204
 205 Uses a list of phone numbers to determine the statuses of those users.
 206 Shows if they are registered on the Signal Servers or not.
 207 In json mode this is outputted as a list of objects.
 208
 209 [NUMBER [NUMBER ...]]::
 210 One or more numbers to check.
 211
 212 === send
 213
 214 Send a message to another user or group.
 215
 216 RECIPIENT::
 217 Specify the recipients’ phone number.
 218
 219 *--note-to-self*::
 220 Send the message to self without notification.
 221
 222 *-g* GROUP, *--group-id* GROUP::
 223 Specify the recipient group ID in base64 encoding.
 224
 225 *-m* MESSAGE, *--message* MESSAGE::
 226 Specify the message.
 227 Currently, signal-cli reads the message from stdin if `-m` is missing, but this will change in a future version and the explicit flag `--message-from-stdin` should be used instead.
 228
 229 *--message-from-stdin*::
 230 Read the message from standard input.
 231
 232 *-a* [ATTACHMENT [ATTACHMENT ...]], *--attachment* [ATTACHMENT [ATTACHMENT ...]]::
 233 Add one or more files as attachment.
 234
 235 *--sticker* STICKER::
 236 Send a sticker of a locally known sticker pack (syntax: stickerPackId:stickerId).
 237 Shouldn't be used together with `-m` as the official clients don't support this.
 238 e.g.: `--sticker 00abac3bc18d7f599bff2325dc306d43:2`
 239
 240 *--mention*::
 241 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.
 242 e.g.: `-m "Hi X!" --mention "3:1:+123456789"`
 243
 244 *--quote-timestamp*::
 245 Specify the timestamp of a previous message with the recipient or group to add a quote to the new message.
 246
 247 *--quote-author*::
 248 Specify the number of the author of the original message.
 249
 250 *--quote-message*::
 251 Specify the message of the original message.
 252
 253 *--quote-mention*::
 254 Specify the mentions of the original message (same format as `--mention`).
 255
 256 *-e*, *--end-session*::
 257 Clear session state and send end session message.
 258
 259 === sendReaction
 260
 261 Send reaction to a previously received or sent message.
 262
 263 RECIPIENT::
 264 Specify the recipients’ phone number.
 265
 266 *-g* GROUP, *--group-id* GROUP::
 267 Specify the recipient group ID in base64 encoding.
 268
 269 *-e* EMOJI, *--emoji* EMOJI::
 270 Specify the emoji, should be a single unicode grapheme cluster.
 271
 272 *-a* NUMBER, *--target-author* NUMBER::
 273 Specify the number of the author of the message to which to react.
 274
 275 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
 276 Specify the timestamp of the message to which to react.
 277
 278 *-r*, *--remove*::
 279 Remove a reaction.
 280
 281 === sendReceipt
 282
 283 Send a read or viewed receipt to a previously received message.
 284
 285 RECIPIENT::
 286 Specify the sender’s phone number.
 287
 288 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
 289 Specify the timestamp of the message to which to react.
 290
 291 *--type* TYPE::
 292 Specify the receipt type, either `read` (the default) or `viewed`.
 293
 294 === sendTyping
 295
 296 Send typing message to trigger a typing indicator for the recipient.
 297 Indicator will be shown for 15seconds unless a typing STOP message is sent first.
 298
 299 RECIPIENT::
 300 Specify the recipients’ phone number.
 301
 302 *-g* GROUP, *--group-id* GROUP::
 303 Specify the recipient group ID in base64 encoding.
 304
 305 *-s*, *--stop*::
 306 Send a typing STOP message.
 307
 308 === remoteDelete
 309
 310 Remotely delete a previously sent message.
 311
 312 RECIPIENT::
 313 Specify the recipients’ phone number.
 314
 315 *-g* GROUP, *--group-id* GROUP::
 316 Specify the recipient group ID in base64 encoding.
 317
 318 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
 319 Specify the timestamp of the message to delete.
 320
 321 === receive
 322
 323 Query the server for new messages.
 324 New messages are printed on standard output and attachments are downloaded to the config directory.
 325 In json mode this is outputted as one json object per line.
 326
 327 *-t* TIMEOUT, *--timeout* TIMEOUT::
 328 Number of seconds to wait for new messages (negative values disable timeout).
 329 Default is 5 seconds.
 330 *--ignore-attachments*::
 331 Don’t download attachments of received messages.
 332
 333 === joinGroup
 334
 335 Join a group via an invitation link.
 336
 337 *--uri*::
 338 The invitation link URI (starts with `https://signal.group/#`)
 339
 340 === updateGroup
 341
 342 Create or update a group.
 343 If the user is a pending member, this command will accept the group invitation.
 344
 345 *-g* GROUP, *--group-id* GROUP::
 346 Specify the recipient group ID in base64 encoding.
 347 If not specified, a new group with a new random ID is generated.
 348
 349 *-n* NAME, *--name* NAME::
 350 Specify the new group name.
 351
 352 *-d* DESCRIPTION, *--description* DESCRIPTION::
 353 Specify the new group description.
 354
 355 *-a* AVATAR, *--avatar* AVATAR::
 356 Specify a new group avatar image file.
 357
 358 *-m* [MEMBER [MEMBER ...]], *--member* [MEMBER [MEMBER ...]]::
 359 Specify one or more members to add to the group.
 360
 361 *-r* [MEMBER [MEMBER ...]], *--remove-member* [MEMBER [MEMBER ...]]::
 362 Specify one or more members to remove from the group
 363
 364 *--admin* [MEMBER [MEMBER ...]]::
 365 Specify one or more members to make a group admin
 366
 367 *--remove-admin* [MEMBER [MEMBER ...]]::
 368 Specify one or more members to remove group admin privileges
 369
 370 *--ban* [MEMBER [MEMBER ...]]::
 371 Specify one or more members to ban from joining the group.
 372 Banned members cannot join or request to join via a group link.
 373
 374 *--unban* [MEMBER [MEMBER ...]]::
 375 Specify one or more members to remove from the ban list
 376
 377 *--reset-link*::
 378 Reset group link and create new link password
 379
 380 *--link* LINK_STATE::
 381 Set group link state: `enabled`, `enabled-with-approval`, `disabled`
 382
 383 *--set-permission-add-member* PERMISSION::
 384 Set permission to add new group members: `every-member`, `only-admins`
 385
 386 *--set-permission-edit-details* PERMISSION::
 387 Set permission to edit group details: `every-member`, `only-admins`
 388
 389 *--set-permission-send-messages* PERMISSION::
 390 Set permission to send messages in group: `every-member`, `only-admins`
 391 Groups where only admins can send messages are also called announcement groups
 392
 393 *-e* EXPIRATION_SECONDS, *--expiration* EXPIRATION_SECONDS::
 394 Set expiration time of messages (seconds).
 395 To disable expiration set expiration time to 0.
 396
 397 === quitGroup
 398
 399 Send a quit group message to all group members and remove self from member list.
 400 If the user is a pending member, this command will decline the group invitation.
 401
 402 *-g* GROUP, *--group-id* GROUP::
 403 Specify the recipient group ID in base64 encoding.
 404
 405 *--delete*::
 406 Delete local group data completely after quitting group.
 407
 408 === listGroups
 409
 410 Show a list of known groups and related information.
 411 In json mode this is outputted as an list of objects and is always in detailed mode.
 412
 413 *-d*, *--detailed*::
 414 Include the list of members of each group and the group invite link.
 415
 416 *-g*, *--group-id*::
 417 Filter the group list by one or more group IDs.
 418
 419 === listContacts
 420
 421 Show a list of known contacts with names.
 422
 423 === listIdentities
 424
 425 List all known identity keys and their trust status, fingerprint and safety number.
 426
 427 *-n* NUMBER, *--number* NUMBER::
 428 Only show identity keys for the given phone number.
 429
 430 === trust
 431
 432 Set the trust level of a given number.
 433 The first time a key for a number is seen, it is trusted by default (TOFU).
 434 If the key changes, the new key must be trusted manually.
 435
 436 number::
 437 Specify the phone number, for which to set the trust.
 438
 439 *-a*, *--trust-all-known-keys*::
 440 Trust all known keys of this user, only use this for testing.
 441
 442 *-v* VERIFIED_SAFETY_NUMBER, *--verified-safety-number* VERIFIED_SAFETY_NUMBER::
 443 Specify the safety number of the key, only use this option if you have verified the safety number.
 444 Can be either the plain text numbers shown in the app or the bytes from the QR-code, encoded as base64.
 445
 446 === updateProfile
 447
 448 Update the profile information shown to message recipients.
 449 The profile is stored encrypted on the Signal servers.
 450 The decryption key is sent with every outgoing messages to contacts and included in every group.
 451
 452 *--given-name* NAME, *--name* NAME::
 453 New (given) name.
 454
 455 *--family-name* FAMILY_NAME::
 456 New family name.
 457
 458 *--about* ABOUT_TEXT::
 459 New profile status text.
 460
 461 *--about-emoji* EMOJI::
 462 New profile status emoji.
 463
 464 *--avatar* AVATAR_FILE::
 465 Path to the new avatar image file.
 466
 467 *--remove-avatar*::
 468 Remove the avatar
 469
 470 === updateContact
 471
 472 Update the info associated to a number on our contact list.
 473 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 474 If the contact doesn't exist yet, it will be added.
 475
 476 NUMBER::
 477 Specify the contact phone number.
 478
 479 *-n*, *--name*::
 480 Specify the new name for this contact.
 481
 482 *-e*, *--expiration* EXPIRATION_SECONDS::
 483 Set expiration time of messages (seconds).
 484 To disable expiration set expiration time to 0.
 485
 486 === removeContact
 487
 488 Remove the info of a given contact
 489
 490 NUMBER::
 491 Specify the contact phone number.
 492
 493 *--forget*::
 494 Delete all data associated with this contact, including identity keys and sessions.
 495
 496 === block
 497
 498 Block the given contacts or groups (no messages will be received).
 499 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 500
 501 [CONTACT [CONTACT ...]]::
 502 Specify the phone numbers of contacts that should be blocked.
 503
 504 *-g* [GROUP [GROUP ...]], *--group-id* [GROUP [GROUP ...]]::
 505 Specify the group IDs that should be blocked in base64 encoding.
 506
 507 === unblock
 508
 509 Unblock the given contacts or groups (messages will be received again).
 510 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 511
 512 [CONTACT [CONTACT ...]]::
 513 Specify the phone numbers of contacts that should be unblocked.
 514
 515 *-g* [GROUP [GROUP ...]], *--group-id* [GROUP [GROUP ...]]::
 516 Specify the group IDs that should be unblocked in base64 encoding.
 517
 518 === sendContacts
 519
 520 Send a synchronization message with the local contacts list to all linked devices.
 521 This command should only be used if this is the master device.
 522
 523 === sendSyncRequest
 524
 525 Send a synchronization request message to the master device (for group, contacts, ...).
 526 The master device will respond with synchronization messages with full contact and group lists.
 527
 528 === uploadStickerPack
 529
 530 Upload a new sticker pack, consisting of a manifest file and the sticker images.
 531 Images must conform to the following specification: (see https://support.signal.org/hc/en-us/articles/360031836512-Stickers#sticker_reqs )
 532
 533 - Static stickers in PNG or WebP format
 534 - Animated stickers in APNG format,
 535 - Maximum file size for a sticker file is 300KiB
 536 - Image resolution of 512 x 512 px
 537
 538 The required manifest.json has the following format:
 539
 540 [source,json]
 541 ----
 542 {
 543   "title": "<STICKER_PACK_TITLE>",
 544   "author": "<STICKER_PACK_AUTHOR>",
 545   "cover": { // Optional cover, by default the first sticker is used as cover
 546     "file": "<name of image file, mandatory>",
 547     "contentType": "<optional>",
 548     "emoji": "<optional>"
 549   },
 550   "stickers": [
 551     {
 552       "file": "<name of image file, mandatory>",
 553       "contentType": "<optional>",
 554       "emoji": "<optional>"
 555     }
 556     ...
 557   ]
 558 }
 559 ----
 560
 561 PATH::
 562 The path of the manifest.json or a zip file containing the sticker pack you wish to upload.
 563
 564 === daemon
 565
 566 signal-cli can run in daemon mode and provides an experimental dbus or JSON-RPC interface.
 567 If no `-a` account is given, all local accounts will be exported as separate dbus objects under the same bus name.
 568
 569 *--dbus*::
 570 Export DBus interface on user bus.
 571 See signal-cli-dbus (5) for info on the dbus interface.
 572
 573 *--dbus-system*::
 574 Export DBus interface on system bus.
 575 See signal-cli-dbus (5) for info on the dbus interface.
 576
 577 *--socket [SOCKET]*::
 578 Export a JSON-RPC interface on a UNIX socket (default $XDG_RUNTIME_DIR/signal-cli/socket).
 579 See signal-cli-jsonrpc (5) for info on the JSON-RPC interface.
 580
 581 *--tcp [HOST:PORT]*::
 582 Export a JSON-RPC interface on a TCP socket (default localhost:7583).
 583 See signal-cli-jsonrpc (5) for info on the JSON-RPC interface.
 584
 585 *--ignore-attachments*::
 586 Don’t download attachments of received messages.
 587
 588 *--no-receive-stdout*::
 589 Don’t print received messages to stdout.
 590
 591 *--receive-mode*::
 592 Specify when to start receiving messages (on-start, on-connection, manual)
 593
 594 == Examples
 595
 596 Register a number (with SMS verification)::
 597 signal-cli -a ACCOUNT register
 598
 599 Verify the number using the code received via SMS or voice::
 600 signal-cli -a ACCOUNT verify CODE
 601
 602 Send a message to one or more recipients::
 603 signal-cli -a ACCOUNT send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
 604
 605 Pipe the message content from another process::
 606 uname -a | signal-cli -a ACCOUNT send --message-from-stdin [RECIPIENT [RECIPIENT ...]]
 607
 608 Create a group::
 609 signal-cli -a ACCOUNT updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
 610
 611 Add member to a group::
 612 signal-cli -a ACCOUNT updateGroup -g GROUP_ID -m "NEW_MEMBER"
 613
 614 Accept a group invitation::
 615 signal-cli -a ACCOUNT updateGroup -g GROUP_ID
 616
 617 Leave a group::
 618 signal-cli -a ACCOUNT quitGroup -g GROUP_ID
 619
 620 Send a message to a group::
 621 signal-cli -a ACCOUNT send -m "This is a message" -g GROUP_ID
 622
 623 Trust new key, after having verified it::
 624 signal-cli -a ACCOUNT trust -v SAFETY_NUMBER NUMBER
 625
 626 Trust new key, without having verified it. Only use this if you don't care about security::
 627 signal-cli -a ACCOUNT trust -a NUMBER
 628
 629 == Exit codes
 630
 631 * *1*: Error is probably caused and fixable by the user
 632 * *2*: Some unexpected error
 633 * *3*: Server or IO error
 634 * *4*: Sending failed due to untrusted key
 635
 636 == Files
 637
 638 The password and cryptographic keys are created when registering and stored in the current users home directory, the directory can be changed with *--config*:
 639
 640 `$XDG_DATA_HOME/signal-cli/` (`$HOME/.local/share/signal-cli/`)
 641
 642 == Authors
 643
 644 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
 645 For more information about signal-cli development, see
 646 <https://github.com/AsamK/signal-cli>.