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