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 link
  77 ~~~~
  78 Link to an existing device, instead of registering a new number.  This shows a
  79 "tsdevice:/…" URI. If you want to connect to another signal-cli instance, you can
  80 just use this URI. If you want to link to an Android/iOS device, create a QR code
  81 with the URI (e.g. with qrencode) and scan that in the Signal app.
  82
  83 *-n* NAME, *--name* NAME::
  84         Optionally specify a name to describe this new device. By default "cli" will
  85         be used.
  86
  87 addDevice
  88 ~~~~~~~~~
  89 Link another device to this device. Only works, if this is the master device.
  90
  91 *--uri* URI::
  92         Specify the uri contained in the QR code shown by the new device.
  93
  94 listDevices
  95 ~~~~~~~~~~~
  96 Show a list of connected devices.
  97
  98 removeDevice
  99 ~~~~~~~~~~~~
 100 Remove a connected device. Only works, if this is the master device.
 101
 102 *-d* DEVICEID, *--deviceId* DEVICEID::
 103         Specify the device you want to remove. Use listDevices to see the deviceIds.
 104
 105 send
 106 ~~~~
 107 Send a message to another user or group.
 108
 109 RECIPIENT::
 110         Specify the recipients’ phone number.
 111
 112 *-g* GROUP, *--group* GROUP::
 113         Specify the recipient group ID in base64 encoding.
 114
 115 *-m* MESSAGE, *--message* MESSAGE::
 116         Specify the message, if missing, standard input is used.
 117
 118 *-a* [ATTACHMENT [ATTACHMENT ...]], *--attachment* [ATTACHMENT [ATTACHMENT ...]]::
 119         Add one or more files as attachment.
 120
 121 *-e*, *--endsession*::
 122         Clear session state and send end session message.
 123
 124 receive
 125 ~~~~~~~
 126 Query the server for new messages. New messages are printed on standardoutput and
 127 attachments are downloaded to the config directory.
 128
 129 *-t* TIMEOUT, *--timeout* TIMEOUT::
 130         Number of seconds to wait for new messages (negative values disable timeout).
 131         Default is 5 seconds.
 132 *--ignore-attachments*::
 133         Don’t download attachments of received messages.
 134
 135 updateGroup
 136 ~~~~~~~~~~~
 137 Create or update a group.
 138
 139 *-g* GROUP, *--group* GROUP::
 140         Specify the recipient group ID in base64 encoding. If not specified, a new
 141         group with a new random ID is generated.
 142
 143 *-n* NAME, *--name* NAME::
 144         Specify the new group name.
 145
 146 *-a* AVATAR, *--avatar* AVATAR::
 147         Specify a new group avatar image file.
 148
 149 *-m* [MEMBER [MEMBER ...]], *--member* [MEMBER [MEMBER ...]]::
 150         Specify one or more members to add to the group.
 151
 152 quitGroup
 153 ~~~~~~~~~
 154 Send a quit group message to all group members and remove self from member list.
 155
 156 *-g* GROUP, *--group* GROUP::
 157         Specify the recipient group ID in base64 encoding.
 158
 159
 160 listIdentities
 161 ~~~~~~~~~~~~~~
 162 List all known identity keys and their trust status, fingerprint and safety
 163 number.
 164
 165 *-n* NUMBER, *--number* NUMBER::
 166         Only show identity keys for the given phone number.
 167
 168 trust
 169 ~~~~~
 170 Set the trust level of a given number. The first time a key for a number is seen,
 171 it is trusted by default (TOFU). If the key changes, the new key must be trusted
 172 manually.
 173
 174 number::
 175         Specify the phone number, for which to set the trust.
 176
 177 *-a*, *--trust-all-known-keys*::
 178         Trust all known keys of this user, only use this for testing.
 179
 180 *-v* VERIFIED_FINGERPRINT, *--verified-fingerprint* VERIFIED_FINGERPRINT::
 181         Specify the safety number or fingerprint of the key, only use this option if you have verified
 182         the fingerprint.
 183
 184
 185 daemon
 186 ~~~~~~
 187 signal-cli can run in daemon mode and provides an experimental dbus interface. For
 188 dbus support you need jni/unix-java.so installed on your system (Debian:
 189 libunixsocket-java ArchLinux: libmatthew-unix-java (AUR)).
 190
 191 *--system*::
 192         Use DBus system bus instead of user bus.
 193 *--ignore-attachments*::
 194         Don’t download attachments of received messages.
 195
 196
 197 Examples
 198 --------
 199
 200 Register a number (with SMS verification)::
 201     signal-cli -u USERNAME register
 202
 203 Verify the number using the code received via SMS or voice::
 204     signal-cli -u USERNAME verify CODE
 205
 206 Send a message to one or more recipients::
 207     signal-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
 208
 209 Pipe the message content from another process::
 210     uname -a | signal-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
 211
 212 Create a group::
 213         signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
 214
 215 Add member to a group::
 216         signal-cli -u USERNAME updateGroup -g GROUP_ID -m "NEW_MEMBER"
 217
 218 Leave a group::
 219         signal-cli -u USERNAME quitGroup -g GROUP_ID
 220
 221 Send a message to a group::
 222         signal-cli -u USERNAME send -m "This is a message" -g GROUP_ID
 223
 224 Trust new key, after having verified it::
 225     signal-cli -u USERNAME trust -v FINGER_PRINT NUMBER
 226
 227 Trust new key, without having verified it. Only use this if you don't care about security::
 228     signal-cli -u USERNAME trust -a NUMBER
 229
 230 Files
 231 -----
 232 The password and cryptographic keys are created when registering and stored in the
 233 current users home directory, the directory can be changed with *--config*:
 234
 235     $HOME/.config/signal/
 236
 237 For legacy users, the old config directory is used as a fallback:
 238
 239     $HOME/.config/textsecure/
 240
 241
 242 Authors
 243 -------
 244
 245 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open
 246 source contributors. For more information about signal-cli development, see
 247 <https://github.com/AsamK/signal-cli>.