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