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