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 === sendTyping
 203
 204 Send typing message to trigger a typing indicator for the recipient.
 205 Indicator will be shown for 15seconds unless a typing STOP message is sent first.
 206
 207 RECIPIENT::
 208 Specify the recipients’ phone number.
 209
 210 *-g* GROUP, *--group-id* GROUP::
 211 Specify the recipient group ID in base64 encoding.
 212
 213 *-s*, *--stop*::
 214 Send a typing STOP message.
 215
 216 === remoteDelete
 217
 218 Remotely delete a previously sent message.
 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 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
 227 Specify the timestamp of the message to delete.
 228
 229 === receive
 230
 231 Query the server for new messages.
 232 New messages are printed on standard output and attachments are downloaded to the config directory.
 233 In json mode this is outputted as one json object per line.
 234
 235 *-t* TIMEOUT, *--timeout* TIMEOUT::
 236 Number of seconds to wait for new messages (negative values disable timeout).
 237 Default is 5 seconds.
 238 *--ignore-attachments*::
 239 Don’t download attachments of received messages.
 240
 241 === joinGroup
 242
 243 Join a group via an invitation link.
 244
 245 *--uri*::
 246 The invitation link URI (starts with `https://signal.group/#`)
 247
 248 === updateGroup
 249
 250 Create or update a group.
 251 If the user is a pending member, this command will accept the group invitation.
 252
 253 *-g* GROUP, *--group-id* GROUP::
 254 Specify the recipient group ID in base64 encoding.
 255 If not specified, a new group with a new random ID is generated.
 256
 257 *-n* NAME, *--name* NAME::
 258 Specify the new group name.
 259
 260 *-d* DESCRIPTION, *--description* DESCRIPTION::
 261 Specify the new group description.
 262
 263 *-a* AVATAR, *--avatar* AVATAR::
 264 Specify a new group avatar image file.
 265
 266 *-m* [MEMBER [MEMBER ...]], *--member* [MEMBER [MEMBER ...]]::
 267 Specify one or more members to add to the group.
 268
 269 *-r* [MEMBER [MEMBER ...]], *--remove-member* [MEMBER [MEMBER ...]]::
 270 Specify one or more members to remove from the group
 271
 272 *--admin* [MEMBER [MEMBER ...]]::
 273 Specify one or more members to make a group admin
 274
 275 *--remove-admin* [MEMBER [MEMBER ...]]::
 276 Specify one or more members to remove group admin privileges
 277
 278 *--reset-link*::
 279 Reset group link and create new link password
 280
 281 *--link* LINK_STATE::
 282 Set group link state: `enabled`, `enabled-with-approval`, `disabled`
 283
 284 *--set-permission-add-member* PERMISSION::
 285 Set permission to add new group members: `every-member`, `only-admins`
 286
 287 *--set-permission-edit-details* PERMISSION::
 288 Set permission to edit group details: `every-member`, `only-admins`
 289
 290 *--set-permission-send-messages* PERMISSION::
 291 Set permission to send messages in group: `every-member`, `only-admins`
 292 Groups where only admins can send messages are also called announcement groups
 293
 294 *-e* EXPIRATION_SECONDS, *--expiration* EXPIRATION_SECONDS::
 295 Set expiration time of messages (seconds).
 296 To disable expiration set expiration time to 0.
 297
 298 === quitGroup
 299
 300 Send a quit group message to all group members and remove self from member list.
 301 If the user is a pending member, this command will decline the group invitation.
 302
 303 *-g* GROUP, *--group-id* GROUP::
 304 Specify the recipient group ID in base64 encoding.
 305
 306 *--delete*::
 307 Delete local group data completely after quitting group.
 308
 309 === listGroups
 310
 311 Show a list of known groups and related information.
 312 In json mode this is outputted as an list of objects and is always in detailed mode.
 313
 314 *-d*, *--detailed*::
 315 Include the list of members of each group and the group invite link.
 316
 317 === listContacts
 318
 319 Show a list of known contacts with names.
 320
 321 === listIdentities
 322
 323 List all known identity keys and their trust status, fingerprint and safety number.
 324
 325 *-n* NUMBER, *--number* NUMBER::
 326 Only show identity keys for the given phone number.
 327
 328 === trust
 329
 330 Set the trust level of a given number.
 331 The first time a key for a number is seen, it is trusted by default (TOFU).
 332 If the key changes, the new key must be trusted manually.
 333
 334 number::
 335 Specify the phone number, for which to set the trust.
 336
 337 *-a*, *--trust-all-known-keys*::
 338 Trust all known keys of this user, only use this for testing.
 339
 340 *-v* VERIFIED_SAFETY_NUMBER, *--verified-safety-number* VERIFIED_SAFETY_NUMBER::
 341 Specify the safety number of the key, only use this option if you have verified the safety number.
 342
 343 === updateProfile
 344
 345 Update the profile information shown to message recipients.
 346 The profile is stored encrypted on the Signal servers.
 347 The decryption key is sent with every outgoing messages to contacts and included
 348 in every group.
 349
 350 *--given-name* NAME, *--name* NAME::
 351 New (given) name.
 352
 353 *--family-name* FAMILY_NAME::
 354 New family name.
 355
 356 *--about* ABOUT_TEXT::
 357 New profile status text.
 358
 359 *--about-emoji* EMOJI::
 360 New profile status emoji.
 361
 362 *--avatar* AVATAR_FILE::
 363 Path to the new avatar image file.
 364
 365 *--remove-avatar*::
 366 Remove the avatar
 367
 368 === updateContact
 369
 370 Update the info associated to a number on our contact list.
 371 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 372 If the contact doesn't exist yet, it will be added.
 373
 374 NUMBER::
 375 Specify the contact phone number.
 376
 377 *-n*, *--name*::
 378 Specify the new name for this contact.
 379
 380 *-e*, *--expiration* EXPIRATION_SECONDS::
 381 Set expiration time of messages (seconds).
 382 To disable expiration set expiration time to 0.
 383
 384 === block
 385
 386 Block the given contacts or groups (no messages will be received).
 387 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 388
 389 [CONTACT [CONTACT ...]]::
 390 Specify the phone numbers of contacts that should be blocked.
 391
 392 *-g* [GROUP [GROUP ...]], *--group-id* [GROUP [GROUP ...]]::
 393 Specify the group IDs that should be blocked in base64 encoding.
 394
 395 === unblock
 396
 397 Unblock the given contacts or groups (messages will be received again).
 398 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 399
 400 [CONTACT [CONTACT ...]]::
 401 Specify the phone numbers of contacts that should be unblocked.
 402
 403 *-g* [GROUP [GROUP ...]], *--group-id* [GROUP [GROUP ...]]::
 404 Specify the group IDs that should be unblocked in base64 encoding.
 405
 406 === sendContacts
 407
 408 Send a synchronization message with the local contacts list to all linked devices.
 409 This command should only be used if this is the master device.
 410
 411 === sendSyncRequest
 412
 413 Send a synchronization request message to the master device (for group, contacts, ...).
 414 The master device will respond with synchronization messages with full contact and
 415 group lists.
 416
 417 === uploadStickerPack
 418
 419 Upload a new sticker pack, consisting of a manifest file and the sticker images.
 420 Images must conform to the following specification: (see https://support.signal.org/hc/en-us/articles/360031836512-Stickers#sticker_reqs )
 421 - Static stickers in PNG or WebP format
 422 - Animated stickers in APNG format,
 423 - Maximum file size for a sticker file is 300KiB
 424 - Image resolution of 512 x 512 px
 425
 426 The required manifest.json has the following format:
 427
 428 [source,json]
 429 ----
 430 {
 431   "title": "<STICKER_PACK_TITLE>",
 432   "author": "<STICKER_PACK_AUTHOR>",
 433   "cover": { // Optional cover, by default the first sticker is used as cover
 434     "file": "<name of image file, mandatory>",
 435     "contentType": "<optional>",
 436     "emoji": "<optional>"
 437   },
 438   "stickers": [
 439     {
 440       "file": "<name of image file, mandatory>",
 441       "contentType": "<optional>",
 442       "emoji": "<optional>"
 443     }
 444     ...
 445   ]
 446 }
 447 ----
 448
 449 PATH::
 450 The path of the manifest.json or a zip file containing the sticker pack you wish to upload.
 451
 452 === daemon
 453
 454 signal-cli can run in daemon mode and provides an experimental dbus interface.
 455 If no `-u` username is given, all local users will be exported as separate dbus
 456 objects under the same bus name.
 457
 458 *--system*::
 459 Use DBus system bus instead of user bus.
 460 *--ignore-attachments*::
 461 Don’t download attachments of received messages.
 462
 463 == Examples
 464
 465 Register a number (with SMS verification)::
 466 signal-cli -u USERNAME register
 467
 468 Verify the number using the code received via SMS or voice::
 469 signal-cli -u USERNAME verify CODE
 470
 471 Send a message to one or more recipients::
 472 signal-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
 473
 474 Pipe the message content from another process::
 475 uname -a | signal-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
 476
 477 Create a group::
 478 signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
 479
 480 Add member to a group::
 481 signal-cli -u USERNAME updateGroup -g GROUP_ID -m "NEW_MEMBER"
 482
 483 Accept a group invitation::
 484 signal-cli -u USERNAME updateGroup -g GROUP_ID
 485
 486 Leave a group::
 487 signal-cli -u USERNAME quitGroup -g GROUP_ID
 488
 489 Send a message to a group::
 490 signal-cli -u USERNAME send -m "This is a message" -g GROUP_ID
 491
 492 Trust new key, after having verified it::
 493 signal-cli -u USERNAME trust -v SAFETY_NUMBER NUMBER
 494
 495 Trust new key, without having verified it. Only use this if you don't care about security::
 496 signal-cli -u USERNAME trust -a NUMBER
 497
 498 == Exit codes
 499 * *1*: Error is probably caused and fixable by the user
 500 * *2*: Some unexpected error
 501 * *3*: Server or IO error
 502 * *4*: Sending failed due to untrusted key
 503
 504 == Files
 505
 506 The password and cryptographic keys are created when registering and stored in the current users home directory, the directory can be changed with *--config*:
 507
 508 `$XDG_DATA_HOME/signal-cli/` (`$HOME/.local/share/signal-cli/`)
 509
 510 == Authors
 511
 512 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
 513 For more information about signal-cli development, see
 514 <https://github.com/AsamK/signal-cli>.