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