nmode's Git Repositories - signal-cli/blob - man/signal-cli.1.txt

   1 /////
   2 vim:set ts=4 sw=4 tw=82 noet:
   3 /////
   4 :quotes.~:
   5
   6 signal-cli (1)
   7 ============
   8
   9 Name
  10 ----
  11 signal-cli - A commandline and dbus interface for the Signal messenger
  12
  13 Synopsis
  14 --------
  15 *signal-cli* [--config CONFIG] [-h | -v | -u USERNAME | --dbus | --dbus-system] command [command-options]
  16
  17 Description
  18 -----------
  19
  20 signal-cli is a commandline interface for libsignal-service-java. It supports
  21 registering, verifying, sending and receiving messages. For registering you need a
  22 phone number where you can receive SMS or incoming calls.
  23 signal-cli was primarily developed to be used on servers to notify admins of
  24 important events. For this use-case, it has a dbus interface, that can be used to
  25 send messages from any programming language that has dbus bindings.
  26
  27 Options
  28 -------
  29
  30 *-h*, *--help*::
  31         Show help message and quit.
  32
  33 *-v*, *--version*::
  34         Print the version and quit.
  35
  36 *--config* CONFIG::
  37         Set the path, where to store the config.
  38         (Default: $HOME/.config/signal)
  39
  40 *-u* USERNAME, *--username* USERNAME::
  41         Specify your phone number, that will be your identifier.
  42         The phone number must include the country calling code, i.e. the number must
  43         start with a "+" sign.
  44
  45 *--dbus*::
  46         Make request via user dbus.
  47
  48 *--dbus-system*::
  49         Make request via system dbus.
  50
  51 Commands
  52 --------
  53
  54 register
  55 ~~~~~~~~
  56 Register a phone number with SMS or voice verification. Use the verify command to
  57 complete the verification.
  58
  59 *-v*, *--voice*::
  60         The verification should be done over voice, not SMS.
  61
  62 verify
  63 ~~~~~~
  64 Verify the number using the code received via SMS or voice.
  65
  66 VERIFICATIONCODE::
  67         The verification code.
  68
  69 unregister
  70 ~~~~~~~~
  71 Disable push support for this device, i.e. this device won't receive any more messages.
  72 If this is the master device, other users can't send messages to this number anymore.
  73 Use "updateAccount" to undo this.
  74 To remove a linked device, use "removeDevice" from the master device.
  75
  76 updateAccount
  77 ~~~~~~~~
  78 Update the account attributes on the signal server.
  79 Can fix problems with receiving messages.
  80
  81 link
  82 ~~~~
  83 Link to an existing device, instead of registering a new number.  This shows a
  84 "tsdevice:/…" URI. If you want to connect to another signal-cli instance, you can
  85 just use this URI. If you want to link to an Android/iOS device, create a QR code
  86 with the URI (e.g. with qrencode) and scan that in the Signal app.
  87
  88 *-n* NAME, *--name* NAME::
  89         Optionally specify a name to describe this new device. By default "cli" will
  90         be used.
  91
  92 addDevice
  93 ~~~~~~~~~
  94 Link another device to this device. Only works, if this is the master device.
  95
  96 *--uri* URI::
  97         Specify the uri contained in the QR code shown by the new device.
  98
  99 listDevices
 100 ~~~~~~~~~~~
 101 Show a list of connected devices.
 102
 103 removeDevice
 104 ~~~~~~~~~~~~
 105 Remove a connected device. Only works, if this is the master device.
 106
 107 *-d* DEVICEID, *--deviceId* DEVICEID::
 108         Specify the device you want to remove. Use listDevices to see the deviceIds.
 109
 110 send
 111 ~~~~
 112 Send a message to another user or group.
 113
 114 RECIPIENT::
 115         Specify the recipients’ phone number.
 116
 117 *-g* GROUP, *--group* GROUP::
 118         Specify the recipient group ID in base64 encoding.
 119
 120 *-m* MESSAGE, *--message* MESSAGE::
 121         Specify the message, if missing, standard input is used.
 122
 123 *-a* [ATTACHMENT [ATTACHMENT ...]], *--attachment* [ATTACHMENT [ATTACHMENT ...]]::
 124         Add one or more files as attachment.
 125
 126 *-e*, *--endsession*::
 127         Clear session state and send end session message.
 128
 129 receive
 130 ~~~~~~~
 131 Query the server for new messages. New messages are printed on standardoutput and
 132 attachments are downloaded to the config directory.
 133
 134 *-t* TIMEOUT, *--timeout* TIMEOUT::
 135         Number of seconds to wait for new messages (negative values disable timeout).
 136         Default is 5 seconds.
 137 *--ignore-attachments*::
 138         Don’t download attachments of received messages.
 139
 140 updateGroup
 141 ~~~~~~~~~~~
 142 Create or update a group.
 143
 144 *-g* GROUP, *--group* GROUP::
 145         Specify the recipient group ID in base64 encoding. If not specified, a new
 146         group with a new random ID is generated.
 147
 148 *-n* NAME, *--name* NAME::
 149         Specify the new group name.
 150
 151 *-a* AVATAR, *--avatar* AVATAR::
 152         Specify a new group avatar image file.
 153
 154 *-m* [MEMBER [MEMBER ...]], *--member* [MEMBER [MEMBER ...]]::
 155         Specify one or more members to add to the group.
 156
 157 quitGroup
 158 ~~~~~~~~~
 159 Send a quit group message to all group members and remove self from member list.
 160
 161 *-g* GROUP, *--group* GROUP::
 162         Specify the recipient group ID in base64 encoding.
 163
 164
 165 listIdentities
 166 ~~~~~~~~~~~~~~
 167 List all known identity keys and their trust status, fingerprint and safety
 168 number.
 169
 170 *-n* NUMBER, *--number* NUMBER::
 171         Only show identity keys for the given phone number.
 172
 173 trust
 174 ~~~~~
 175 Set the trust level of a given number. The first time a key for a number is seen,
 176 it is trusted by default (TOFU). If the key changes, the new key must be trusted
 177 manually.
 178
 179 number::
 180         Specify the phone number, for which to set the trust.
 181
 182 *-a*, *--trust-all-known-keys*::
 183         Trust all known keys of this user, only use this for testing.
 184
 185 *-v* VERIFIED_FINGERPRINT, *--verified-fingerprint* VERIFIED_FINGERPRINT::
 186         Specify the safety number or fingerprint of the key, only use this option if you have verified
 187         the fingerprint.
 188
 189
 190 daemon
 191 ~~~~~~
 192 signal-cli can run in daemon mode and provides an experimental dbus interface. For
 193 dbus support you need jni/unix-java.so installed on your system (Debian:
 194 libunixsocket-java ArchLinux: libmatthew-unix-java (AUR)).
 195
 196 *--system*::
 197         Use DBus system bus instead of user bus.
 198 *--ignore-attachments*::
 199         Don’t download attachments of received messages.
 200
 201
 202 Examples
 203 --------
 204
 205 Register a number (with SMS verification)::
 206     signal-cli -u USERNAME register
 207
 208 Verify the number using the code received via SMS or voice::
 209     signal-cli -u USERNAME verify CODE
 210
 211 Send a message to one or more recipients::
 212     signal-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
 213
 214 Pipe the message content from another process::
 215     uname -a | signal-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
 216
 217 Create a group::
 218         signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
 219
 220 Add member to a group::
 221         signal-cli -u USERNAME updateGroup -g GROUP_ID -m "NEW_MEMBER"
 222
 223 Leave a group::
 224         signal-cli -u USERNAME quitGroup -g GROUP_ID
 225
 226 Send a message to a group::
 227         signal-cli -u USERNAME send -m "This is a message" -g GROUP_ID
 228
 229 Trust new key, after having verified it::
 230     signal-cli -u USERNAME trust -v FINGER_PRINT NUMBER
 231
 232 Trust new key, without having verified it. Only use this if you don't care about security::
 233     signal-cli -u USERNAME trust -a NUMBER
 234
 235 Files
 236 -----
 237 The password and cryptographic keys are created when registering and stored in the
 238 current users home directory, the directory can be changed with *--config*:
 239
 240     $HOME/.config/signal/
 241
 242 For legacy users, the old config directory is used as a fallback:
 243
 244     $HOME/.config/textsecure/
 245
 246
 247 Authors
 248 -------
 249
 250 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open
 251 source contributors. For more information about signal-cli development, see
 252 <https://github.com/AsamK/signal-cli>.