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