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 *--dbus*::
  48 Make request via user dbus.
  49
  50 *--dbus-system*::
  51 Make request via system dbus.
  52
  53 *-o* OUTPUT-MODE, *--output* OUTPUT-MODE::
  54 Specify if you want commands to output in either "plain-text" mode or in "json". Defaults to "plain-text"
  55
  56 == Commands
  57
  58 === register
  59
  60 Register a phone number with SMS or voice verification.
  61 Use the verify command to complete the verification.
  62
  63 *-v*, *--voice*::
  64 The verification should be done over voice, not SMS.
  65
  66 *--captcha*::
  67 The captcha token, required if registration failed with a captcha required error.
  68 To get the token, go to https://signalcaptchas.org/registration/generate.html
  69 Check the developer tools for a redirect starting with signalcaptcha://
  70 Everything after signalcaptcha:// is the captcha token.
  71
  72 === verify
  73
  74 Verify the number using the code received via SMS or voice.
  75
  76 VERIFICATIONCODE::
  77 The verification code.
  78
  79 *-p* PIN, *--pin* PIN::
  80 The registration lock PIN, that was set by the user.
  81 Only required if a PIN was set.
  82
  83 === unregister
  84
  85 Disable push support for this device, i.e. this device won't receive any more messages.
  86 If this is the master device, other users can't send messages to this number anymore.
  87 Use "updateAccount" to undo this.
  88 To remove a linked device, use "removeDevice" from the master device.
  89
  90 === updateAccount
  91
  92 Update the account attributes on the signal server.
  93 Can fix problems with receiving messages.
  94
  95 === setPin
  96
  97 Set a registration lock pin, to prevent others from registering this number.
  98
  99 REGISTRATION_LOCK_PIN::
 100 The registration lock PIN, that will be required for new registrations (resets after 7 days of inactivity)
 101
 102 === removePin
 103
 104 Remove the registration lock pin.
 105
 106 === link
 107
 108 Link to an existing device, instead of registering a new number.
 109 This shows a "tsdevice:/…" URI. If you want to connect to another signal-cli instance, you can just use this URI.
 110 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.
 111
 112 *-n* NAME, *--name* NAME::
 113 Optionally specify a name to describe this new device.
 114 By default "cli" will be used.
 115
 116 === addDevice
 117
 118 Link another device to this device.
 119 Only works, if this is the master device.
 120
 121 *--uri* URI::
 122 Specify the uri contained in the QR code shown by the new device.
 123 You will need the full uri enclosed in quotation marks, such as "tsdevice:/?uuid=....."
 124
 125 === listDevices
 126
 127 Show a list of connected devices.
 128
 129 === removeDevice
 130
 131 Remove a connected device.
 132 Only works, if this is the master device.
 133
 134 *-d* DEVICEID, *--deviceId* DEVICEID::
 135 Specify the device you want to remove.
 136 Use listDevices to see the deviceIds.
 137
 138 === getUserStatus
 139
 140 Uses a list of phone numbers to determine the statuses of those users.
 141 Shows if they are registered on the Signal Servers or not.
 142 In json mode this is outputted as a list of objects.
 143
 144 [NUMBER [NUMBER ...]]::
 145 One or more numbers to check.
 146
 147 === send
 148
 149 Send a message to another user or group.
 150
 151 RECIPIENT::
 152 Specify the recipients’ phone number.
 153
 154 *-g* GROUP, *--group* GROUP::
 155 Specify the recipient group ID in base64 encoding.
 156
 157 *-m* MESSAGE, *--message* MESSAGE::
 158 Specify the message, if missing, standard input is used.
 159
 160 *-a* [ATTACHMENT [ATTACHMENT ...]], *--attachment* [ATTACHMENT [ATTACHMENT ...]]::
 161 Add one or more files as attachment.
 162
 163 *-e*, *--endsession*::
 164 Clear session state and send end session message.
 165
 166 === sendReaction
 167
 168 Send reaction to a previously received or sent message.
 169
 170 RECIPIENT::
 171 Specify the recipients’ phone number.
 172
 173 *-g* GROUP, *--group* GROUP::
 174 Specify the recipient group ID in base64 encoding.
 175
 176 *-e* EMOJI, *--emoji* EMOJI::
 177 Specify the emoji, should be a single unicode grapheme cluster.
 178
 179 *-a* NUMBER, *--target-author* NUMBER::
 180 Specify the number of the author of the message to which to react.
 181
 182 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
 183 Specify the timestamp of the message to which to react.
 184
 185 *-r*, *--remove*::
 186 Remove a reaction.
 187
 188 === receive
 189
 190 Query the server for new messages.
 191 New messages are printed on standard output and attachments are downloaded to the config directory.
 192 In json mode this is outputted as one json object per line.
 193
 194 *-t* TIMEOUT, *--timeout* TIMEOUT::
 195 Number of seconds to wait for new messages (negative values disable timeout).
 196 Default is 5 seconds.
 197 *--ignore-attachments*::
 198 Don’t download attachments of received messages.
 199
 200 === joinGroup
 201
 202 Join a group via an invitation link.
 203 To be able to join a v2 group the account needs to have a profile (can be created
 204 with the `updateProfile` command)
 205
 206 *--uri*::
 207 The invitation link URI (starts with `https://signal.group/#`)
 208
 209 === updateGroup
 210
 211 Create or update a group.
 212 If the user is a pending member, this command will accept the group invitation.
 213 To be able to join or create a v2 group the account needs to have a profile (can
 214 be created with the `updateProfile` command)
 215
 216 *-g* GROUP, *--group* GROUP::
 217 Specify the recipient group ID in base64 encoding.
 218 If not specified, a new group with a new random ID is generated.
 219
 220 *-n* NAME, *--name* NAME::
 221 Specify the new group name.
 222
 223 *-a* AVATAR, *--avatar* AVATAR::
 224 Specify a new group avatar image file.
 225
 226 *-m* [MEMBER [MEMBER ...]], *--member* [MEMBER [MEMBER ...]]::
 227 Specify one or more members to add to the group.
 228
 229 === quitGroup
 230
 231 Send a quit group message to all group members and remove self from member list.
 232 If the user is a pending member, this command will decline the group invitation.
 233
 234 *-g* GROUP, *--group* GROUP::
 235 Specify the recipient group ID in base64 encoding.
 236
 237 === listGroups
 238
 239 Show a list of known groups and related information.
 240 In json mode this is outputted as an list of objects and is always in detailed mode.
 241
 242 *-d*, *--detailed*::
 243 Include the list of members of each group and the group invite link.
 244
 245 === listIdentities
 246
 247 List all known identity keys and their trust status, fingerprint and safety number.
 248
 249 *-n* NUMBER, *--number* NUMBER::
 250 Only show identity keys for the given phone number.
 251
 252 === trust
 253
 254 Set the trust level of a given number.
 255 The first time a key for a number is seen, it is trusted by default (TOFU).
 256 If the key changes, the new key must be trusted manually.
 257
 258 number::
 259 Specify the phone number, for which to set the trust.
 260
 261 *-a*, *--trust-all-known-keys*::
 262 Trust all known keys of this user, only use this for testing.
 263
 264 *-v* VERIFIED_SAFETY_NUMBER, *--verified-safety-number* VERIFIED_SAFETY_NUMBER::
 265 Specify the safety number of the key, only use this option if you have verified the safety number.
 266
 267 === updateProfile
 268
 269 Update the name and avatar image visible by message recipients for the current users.
 270 The profile is stored encrypted on the Signal servers.
 271 The decryption key is sent with every outgoing messages to contacts.
 272
 273 *--name*::
 274 New name visible by message recipients.
 275
 276 *--avatar*::
 277 Path to the new avatar visible by message recipients.
 278
 279 *--remove-avatar*::
 280 Remove the avatar visible by message recipients.
 281
 282 === updateContact
 283
 284 Update the info associated to a number on our contact list.
 285 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 286 If the contact doesn't exist yet, it will be added.
 287
 288 NUMBER::
 289 Specify the contact phone number.
 290
 291 *-n*, *--name*::
 292 Specify the new name for this contact.
 293
 294 *-e*, *--expiration*::
 295 Set expiration time of messages (seconds).
 296 To disable expiration set expiration time to 0.
 297
 298 === block
 299
 300 Block the given contacts or groups (no messages will be received).
 301 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 302
 303 [CONTACT [CONTACT ...]]::
 304 Specify the phone numbers of contacts that should be blocked.
 305
 306 *-g* [GROUP [GROUP ...]], *--group* [GROUP [GROUP ...]]::
 307 Specify the group IDs that should be blocked in base64 encoding.
 308
 309 === unblock
 310
 311 Unblock the given contacts or groups (messages will be received again).
 312 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
 313
 314 [CONTACT [CONTACT ...]]::
 315 Specify the phone numbers of contacts that should be unblocked.
 316
 317 *-g* [GROUP [GROUP ...]], *--group* [GROUP [GROUP ...]]::
 318 Specify the group IDs that should be unblocked in base64 encoding.
 319
 320 === sendContacts
 321
 322 Send a synchronization message with the local contacts list to all linked devices.
 323 This command should only be used if this is the master device.
 324
 325 === uploadStickerPack
 326
 327 Upload a new sticker pack, consisting of a manifest file and the stickers in WebP format (maximum size for a sticker file is 100KiB).
 328 The required manifest.json has the following format:
 329
 330 [source,json]
 331 ----
 332 {
 333   "title": "<STICKER_PACK_TITLE>",
 334   "author": "<STICKER_PACK_AUTHOR>",
 335   "cover": { // Optional cover, by default the first sticker is used as cover
 336     "file": "<name of webp file, mandatory>",
 337     "emoji": "<optional>"
 338   },
 339   "stickers": [
 340     {
 341       "file": "<name of webp file, mandatory>",
 342       "emoji": "<optional>"
 343     }
 344     ...
 345   ]
 346 }
 347 ----
 348
 349 PATH::
 350 The path of the manifest.json or a zip file containing the sticker pack you wish to upload.
 351
 352 === daemon
 353
 354 signal-cli can run in daemon mode and provides an experimental dbus interface.
 355
 356 *--system*::
 357 Use DBus system bus instead of user bus.
 358 *--ignore-attachments*::
 359 Don’t download attachments of received messages.
 360
 361 == Examples
 362
 363 Register a number (with SMS verification)::
 364 signal-cli -u USERNAME register
 365
 366 Verify the number using the code received via SMS or voice::
 367 signal-cli -u USERNAME verify CODE
 368
 369 Send a message to one or more recipients::
 370 signal-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
 371
 372 Pipe the message content from another process::
 373 uname -a | signal-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
 374
 375 Create a group::
 376 signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
 377
 378 Add member to a group::
 379 signal-cli -u USERNAME updateGroup -g GROUP_ID -m "NEW_MEMBER"
 380
 381 Leave a group::
 382 signal-cli -u USERNAME quitGroup -g GROUP_ID
 383
 384 Send a message to a group::
 385 signal-cli -u USERNAME send -m "This is a message" -g GROUP_ID
 386
 387 Trust new key, after having verified it::
 388 signal-cli -u USERNAME trust -v SAFETY_NUMBER NUMBER
 389
 390 Trust new key, without having verified it. Only use this if you don't care about security::
 391 signal-cli -u USERNAME trust -a NUMBER
 392
 393 == Files
 394
 395 The password and cryptographic keys are created when registering and stored in the current users home directory, the directory can be changed with *--config*:
 396
 397 `$XDG_DATA_HOME/signal-cli/` (`$HOME/.local/share/signal-cli/`)
 398
 399 For legacy users, the old config directories are used as a fallback:
 400
 401     $HOME/.config/signal/
 402
 403     $HOME/.config/textsecure/
 404
 405 == Authors
 406
 407 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
 408 For more information about signal-cli development, see
 409 <https://github.com/AsamK/signal-cli>.