nmode's Git Repositories - signal-cli/blob - README.md

   1 # signal-cli
   2
   3 signal-cli is a commandline interface for [libsignal-service-java](https://github.com/WhisperSystems/libsignal-service-java). It supports registering, verifying, sending and receiving messages. To be able to receiving messages signal-cli uses a [patched libsignal-service-java](https://github.com/AsamK/libsignal-service-java), because libsignal-service-java [does not yet support registering for the websocket support](https://github.com/WhisperSystems/libsignal-service-java/pull/5) nor [provisioning as a slave device](https://github.com/WhisperSystems/libsignal-service-java/pull/21). For registering you need a phone number where you can receive SMS or incoming calls.
   4 It is primarily intended to be used on servers to notify admins of important events. For this use-case, it has a dbus interface, that can be used to send messages from any programming language that has dbus bindings.
   5
   6 ## Installation
   7
   8 You can [build signal-cli](#building) yourself, or use the [provided binary files](https://github.com/AsamK/signal-cli/releases/latest), which should work on Linux, macOS and Windows. For Arch Linux there is also a [package in AUR](https://aur.archlinux.org/packages/signal-cli/). You need to have at least JRE 7 installed, to run signal-cli.
   9
  10 ### Install system-wide on Linux
  11 ```sh
  12 export VERSION=<latest version, e.g. "0.4.0">
  13 wget https://github.com/AsamK/signal-cli/releases/download/v"${VERSION}"/signal-cli-"${VERSION}".tar.gz
  14 sudo tar xf signal-cli-"${VERSION}".tar.gz -C /opt
  15 sudo ln -sf /opt/signal-cli-"${VERSION}"/bin/signal-cli /usr/local/bin/
  16 ```
  17
  18 ## Usage
  19
  20 usage: signal-cli [-h] [-v] [--config CONFIG] [-u USERNAME | --dbus | --dbus-system] {link,addDevice,listDevices,removeDevice,register,verify,send,quitGroup,updateGroup,receive,daemon} ...
  21
  22 * Register a number (with SMS verification)
  23
  24         signal-cli -u USERNAME register
  25
  26 * Register a number (with voice verification)
  27
  28         signal-cli -u USERNAME register -v
  29
  30 * Verify the number using the code received via SMS or voice
  31
  32         signal-cli -u USERNAME verify CODE
  33
  34 * Send a message to one or more recipients
  35
  36         signal-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
  37
  38 * Pipe the message content from another process.
  39
  40         uname -a | signal-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
  41
  42 * Receive messages
  43
  44         signal-cli -u USERNAME receive
  45
  46 * Groups
  47
  48  * Create a group
  49
  50           signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
  51
  52  * Update a group
  53
  54           signal-cli -u USERNAME updateGroup -g GROUP_ID -n "New group name" -a "AVATAR_IMAGE_FILE"
  55
  56  * Add member to a group
  57
  58           signal-cli -u USERNAME updateGroup -g GROUP_ID -m "NEW_MEMBER"
  59
  60  * Leave a group
  61
  62           signal-cli -u USERNAME quitGroup -g GROUP_ID
  63
  64  * Send a message to a group
  65
  66           signal-cli -u USERNAME send -m "This is a message" -g GROUP_ID
  67
  68 * Linking other devices (Provisioning)
  69
  70  * Connect to another device
  71
  72           signal-cli link -n "optional device name"
  73
  74         This shows a "tsdevice:/…" link, if you want to connect to another signal-cli instance, you can just use this link. If you want to link to and Android device, create a QR code with the link (e.g. with [qrencode](https://fukuchi.org/works/qrencode/)) and scan that in the Signal Android app.
  75
  76  * Add another device
  77
  78           signal-cli -u USERNAME addDevice --uri "tsdevice:/…"
  79
  80         The "tsdevice:/…" link is the one shown by the new signal-cli instance or contained in the QR code shown in Signal-Desktop or similar apps.
  81         Only the master device (that was registered directly, not linked) can add new devices.
  82
  83  * Manage linked devices
  84
  85           signal-cli -u USERNAME listDevices
  86
  87           signal-cli -u USERNAME removeDevice -d DEVICE_ID
  88
  89 ## DBus service
  90
  91 signal-cli can run in daemon mode and provides an experimental dbus interface.
  92 For dbus support you need jni/unix-java.so installed on your system (Debian: libunixsocket-java ArchLinux: libmatthew-unix-java (AUR)).
  93
  94 * Run in daemon mode (dbus session bus)
  95
  96           signal-cli -u USERNAME daemon
  97
  98 * Send a message via dbus
  99
 100           signal-cli --dbus send -m "Message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
 101
 102 ### System bus
 103
 104 To run on the system bus you need to take some additional steps.
 105 It’s advisable to run signal-cli as a separate unix user, the following steps assume you created a user named *signal-cli*.
 106 These steps, executed as root, should work on all distributions using systemd.
 107
 108 ```bash
 109 cp data/org.asamk.Signal.conf /etc/dbus-1/system.d/
 110 cp data/org.asamk.Signal.service /usr/share/dbus-1/system-services/
 111 cp data/signal.service /etc/systemd/system/
 112 sed -i -e "s|%dir%|<INSERT_INSTALL_PATH>|" -e "s|%number%|<INSERT_YOUR_NUMBER>|" /etc/systemd/system/signal.service
 113 systemctl daemon-reload
 114 systemctl enable signal.service
 115 systemctl reload dbus.service
 116 ```
 117
 118 Then just execute the send command from above, the service will be autostarted by dbus the first time it is requested.
 119
 120 ## Storage
 121
 122 The password and cryptographic keys are created when registering and stored in the current users home directory:
 123
 124         $HOME/.config/signal/data/
 125
 126 For legacy users, the old config directory is used as a fallback:
 127
 128         $HOME/.config/textsecure/data/
 129
 130 ## Building
 131
 132 This project uses [Gradle](http://gradle.org) for building and maintaining
 133 dependencies. If you have a recent gradle version installed, you can replace `./gradlew` with `gradle` in the following steps.
 134
 135 1. Checkout the source somewhere on your filesystem with
 136
 137         git clone https://github.com/AsamK/signal-cli.git
 138
 139 2. Execute Gradle:
 140
 141         ./gradlew build
 142
 143 3. Create shell wrapper in *build/install/signal-cli/bin*:
 144
 145         ./gradlew installDist
 146
 147 4. Create tar file in *build/distributions*:
 148
 149         ./gradlew distTar
 150
 151 ## Troubleshooting
 152 If you use a version of the Oracle JRE and get an InvalidKeyException you need to enable unlimited strength crypto. See https://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters for instructions.
 153
 154 ## License
 155
 156 This project uses libsignal-service-java from Open Whisper Systems:
 157
 158 https://github.com/WhisperSystems/libsignal-service-java
 159
 160 Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html