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