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