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 connected devices.
 139
 140 === removeDevice
 141
 142 Remove a connected device.
 143 Only works, if this is the master device.
 144
 145 *-d* DEVICEID, *--deviceId* DEVICEID::
 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* 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*, *--endsession*::
 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* 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 === remoteDelete
 203
 204 Remotely delete a previously sent message.
 205
 206 RECIPIENT::
 207 Specify the recipients’ phone number.
 208
 209 *-g* GROUP, *--group* GROUP::
 210 Specify the recipient group ID in base64 encoding.
 211
 212 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
 213 Specify the timestamp of the message to delete.
 214
 215 === receive
 216
 217 Query the server for new messages.
 218 New messages are printed on standard output and attachments are downloaded to the config directory.
 219 In json mode this is outputted as one json object per line.
 220
 221 *-t* TIMEOUT, *--timeout* TIMEOUT::
 222 Number of seconds to wait for new messages (negative values disable timeout).
 223 Default is 5 seconds.
 224 *--ignore-attachments*::
 225 Don’t download attachments of received messages.
 226
 227 === joinGroup
 228
 229 Join a group via an invitation link.
 230
 231 *--uri*::
 232 The invitation link URI (starts with `https://signal.group/#`)
 233
 234 === updateGroup
 235
 236 Create or update a group.
 237 If the user is a pending member, this command will accept the group invitation.
 238
 239 *-g* GROUP, *--group* GROUP::
 240 Specify the recipient group ID in base64 encoding.
 241 If not specified, a new group with a new random ID is generated.
 242
 243 *-n* NAME, *--name* NAME::
 244 Specify the new group name.
 245
 246 *-a* AVATAR, *--avatar* AVATAR::
 247 Specify a new group avatar image file.
 248
 249 *-m* [MEMBER [MEMBER ...]], *--member* [MEMBER [MEMBER ...]]::
 250 Specify one or more members to add to the group.
 251
 252 === quitGroup
 253
 254 Send a quit group message to all group members and remove self from member list.
 255 If the user is a pending member, this command will decline the group invitation.
 256
 257 *-g* GROUP, *--group* GROUP::
 258 Specify the recipient group ID in base64 encoding.
 259
 260 === listGroups
 261
 262 Show a list of known groups and related information.
 263 In json mode this is outputted as an list of objects and is always in detailed mode.
 264
 265 *-d*, *--detailed*::
 266 Include the list of members of each group and the group invite link.
 267
 268 === listIdentities
 269
 270 List all known identity keys and their trust status, fingerprint and safety number.
 271
 272 *-n* NUMBER, *--number* NUMBER::
 273 Only show identity keys for the given phone number.
 274
 275 === trust
 276
 277 Set the trust level of a given number.
 278 The first time a key for a number is seen, it is trusted by default (TOFU).
 279 If the key changes, the new key must be trusted manually.
 280
 281 number::
 282 Specify the phone number, for which to set the trust.
 283
 284 *-a*, *--trust-all-known-keys*::
 285 Trust all known keys of this user, only use this for testing.
 286
 287 *-v* VERIFIED_SAFETY_NUMBER, *--verified-safety-number* VERIFIED_SAFETY_NUMBER::
 288 Specify the safety number of the key, only use this option if you have verified the safety number.
 289
 290 === updateProfile
 291
 292 Update the name and avatar image visible by message recipients for the current users.
 293 The profile is stored encrypted on the Signal servers.
 294 The decryption key is sent with every outgoing messages to contacts.
 295
 296 *--name*::
 297 New name visible by message recipients.
 298
 299 *--avatar*::
 300 Path to the new avatar visible by message recipients.
 301
 302 *--remove-avatar*::
 303 Remove the avatar visible by message recipients.
 304
 305 === updateContact
 306
 307 Update the info associated to a number on our contact list.
 308 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 309 If the contact doesn't exist yet, it will be added.
 310
 311 NUMBER::
 312 Specify the contact phone number.
 313
 314 *-n*, *--name*::
 315 Specify the new name for this contact.
 316
 317 *-e*, *--expiration*::
 318 Set expiration time of messages (seconds).
 319 To disable expiration set expiration time to 0.
 320
 321 === block
 322
 323 Block the given contacts or groups (no messages will be received).
 324 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 325
 326 [CONTACT [CONTACT ...]]::
 327 Specify the phone numbers of contacts that should be blocked.
 328
 329 *-g* [GROUP [GROUP ...]], *--group* [GROUP [GROUP ...]]::
 330 Specify the group IDs that should be blocked in base64 encoding.
 331
 332 === unblock
 333
 334 Unblock the given contacts or groups (messages will be received again).
 335 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 336
 337 [CONTACT [CONTACT ...]]::
 338 Specify the phone numbers of contacts that should be unblocked.
 339
 340 *-g* [GROUP [GROUP ...]], *--group* [GROUP [GROUP ...]]::
 341 Specify the group IDs that should be unblocked in base64 encoding.
 342
 343 === sendContacts
 344
 345 Send a synchronization message with the local contacts list to all linked devices.
 346 This command should only be used if this is the master device.
 347
 348 === uploadStickerPack
 349
 350 Upload a new sticker pack, consisting of a manifest file and the stickers in WebP format (maximum size for a sticker file is 100KiB).
 351 The required manifest.json has the following format:
 352
 353 [source,json]
 354 ----
 355 {
 356   "title": "<STICKER_PACK_TITLE>",
 357   "author": "<STICKER_PACK_AUTHOR>",
 358   "cover": { // Optional cover, by default the first sticker is used as cover
 359     "file": "<name of webp file, mandatory>",
 360     "emoji": "<optional>"
 361   },
 362   "stickers": [
 363     {
 364       "file": "<name of webp file, mandatory>",
 365       "emoji": "<optional>"
 366     }
 367     ...
 368   ]
 369 }
 370 ----
 371
 372 PATH::
 373 The path of the manifest.json or a zip file containing the sticker pack you wish to upload.
 374
 375 === daemon
 376
 377 signal-cli can run in daemon mode and provides an experimental dbus interface.
 378 If no `-u` username is given, all local users will be exported as separate dbus
 379 objects under the same bus name.
 380
 381 *--system*::
 382 Use DBus system bus instead of user bus.
 383 *--ignore-attachments*::
 384 Don’t download attachments of received messages.
 385
 386 == Examples
 387
 388 Register a number (with SMS verification)::
 389 signal-cli -u USERNAME register
 390
 391 Verify the number using the code received via SMS or voice::
 392 signal-cli -u USERNAME verify CODE
 393
 394 Send a message to one or more recipients::
 395 signal-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
 396
 397 Pipe the message content from another process::
 398 uname -a | signal-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
 399
 400 Create a group::
 401 signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
 402
 403 Add member to a group::
 404 signal-cli -u USERNAME updateGroup -g GROUP_ID -m "NEW_MEMBER"
 405
 406 Leave a group::
 407 signal-cli -u USERNAME quitGroup -g GROUP_ID
 408
 409 Send a message to a group::
 410 signal-cli -u USERNAME send -m "This is a message" -g GROUP_ID
 411
 412 Trust new key, after having verified it::
 413 signal-cli -u USERNAME trust -v SAFETY_NUMBER NUMBER
 414
 415 Trust new key, without having verified it. Only use this if you don't care about security::
 416 signal-cli -u USERNAME trust -a NUMBER
 417
 418 == Exit codes
 419 * *1*: Error is probably caused and fixable by the user
 420 * *2*: Some unexpected error
 421 * *3*: Server or IO error
 422 * *4*: Sending failed due to untrusted key
 423
 424 == Files
 425
 426 The password and cryptographic keys are created when registering and stored in the current users home directory, the directory can be changed with *--config*:
 427
 428 `$XDG_DATA_HOME/signal-cli/` (`$HOME/.local/share/signal-cli/`)
 429
 430 For legacy users, the old config directories are used as a fallback:
 431
 432     $HOME/.config/signal/
 433
 434     $HOME/.config/textsecure/
 435
 436 == Authors
 437
 438 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
 439 For more information about signal-cli development, see
 440 <https://github.com/AsamK/signal-cli>.