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