X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/df0ae3b8dd7d77ddaeb829b10d804e1cbcadbf8b..ee5062a2cc83078d1d1d33cba32bbaa89e96f52e:/README.md diff --git a/README.md b/README.md index b3c93982..6da7b477 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,117 @@ -# textsecure-cli +# signal-cli -textsecure-cli is a commandline interface for [libtextsecure-java](https://github.com/WhisperSystems/libtextsecure-java). It supports registering, verifying, sending and receiving messages. However receiving messages currently only works with a patched libtextsecure-java, because libtextsecure-java [does not yet support registering for the websocket support](https://github.com/WhisperSystems/libtextsecure-java/pull/5). For registering you need a phone number where you can receive SMS or incoming calls. -It is primarily intended to be used on servers to notify admins of important events. +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. +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. + +## Installation + +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. + +### Install system-wide on Linux +```sh +export VERSION= +wget https://github.com/AsamK/signal-cli/releases/download/v"${VERSION}"/signal-cli-"${VERSION}".tar.gz +sudo tar xf signal-cli-"${VERSION}".tar.gz -C /opt +sudo ln -sf /opt/signal-cli-"${VERSION}"/bin/signal-cli /usr/local/bin/ +``` ## Usage -usage: textsecure-cli [-h] [-u USERNAME] [-v] {register,verify,send,quitGroup,updateGroup,receive} ... +usage: signal-cli [-h] [-v] [--config CONFIG] [-u USERNAME | --dbus | --dbus-system] {link,addDevice,listDevices,removeDevice,register,verify,send,quitGroup,updateGroup,receive,daemon} ... * Register a number (with SMS verification) - textsecure-cli -u USERNAME register + signal-cli -u USERNAME register * Register a number (with voice verification) - textsecure-cli -u USERNAME register -v + signal-cli -u USERNAME register -v * Verify the number using the code received via SMS or voice - textsecure-cli -u USERNAME verify CODE + signal-cli -u USERNAME verify CODE * Send a message to one or more recipients - textsecure-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]] + signal-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]] * Pipe the message content from another process. - uname -a | textsecure-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]] + uname -a | signal-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]] + +* Receive messages + + signal-cli -u USERNAME receive * Groups * Create a group - textsecure-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]] + signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]] * Update a group - textsecure-cli -u USERNAME updateGroup -g GROUP_ID -n "New group name" + signal-cli -u USERNAME updateGroup -g GROUP_ID -n "New group name" -a "AVATAR_IMAGE_FILE" + + * Add member to a group + + signal-cli -u USERNAME updateGroup -g GROUP_ID -m "NEW_MEMBER" + + * Leave a group + + signal-cli -u USERNAME quitGroup -g GROUP_ID * Send a message to a group - textsecure-cli -u USERNAME send -m "This is a message" -g GROUP_ID + signal-cli -u USERNAME send -m "This is a message" -g GROUP_ID + +* Linking other devices (Provisioning) + + * Connect to another device + + signal-cli link -n "optional device name" + + 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. + + * Add another device + + signal-cli -u USERNAME addDevice --uri "tsdevice:/…" + + 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. + Only the master device (that was registered directly, not linked) can add new devices. + + * Manage linked devices + + signal-cli -u USERNAME listDevices + + signal-cli -u USERNAME removeDevice -d DEVICE_ID ## DBus service -textsecure-cli can run in daemon mode and provides an experimental dbus interface. +signal-cli can run in daemon mode and provides an experimental dbus interface. For dbus support you need jni/unix-java.so installed on your system (Debian: libunixsocket-java ArchLinux: libmatthew-unix-java (AUR)). * Run in daemon mode (dbus session bus) - textsecure-cli -u USERNAME daemon + signal-cli -u USERNAME daemon * Send a message via dbus - textsecure-cli --dbus send -m "Message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]] + signal-cli --dbus send -m "Message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]] ### System bus To run on the system bus you need to take some additional steps. -It’s advisable to run textsecure-cli as a separate unix user, the following steps assume you created a user named *textsecure*. +It’s advisable to run signal-cli as a separate unix user, the following steps assume you created a user named *signal-cli*. These steps, executed as root, should work on all distributions using systemd. ```bash -cp data/org.asamk.TextSecure.conf /etc/dbus-1/system.d/ -cp data/org.asamk.TextSecure.service /usr/share/dbus-1/system-services/ -cp data/textsecure.service /etc/systemd/system/ -sed -i -e "s|%dir%||" -e "s|%number%||" /etc/systemd/system/textsecure.service +cp data/org.asamk.Signal.conf /etc/dbus-1/system.d/ +cp data/org.asamk.Signal.service /usr/share/dbus-1/system-services/ +cp data/signal.service /etc/systemd/system/ +sed -i -e "s|%dir%||" -e "s|%number%||" /etc/systemd/system/signal.service systemctl daemon-reload -systemctl enable textsecure.service +systemctl enable signal.service systemctl reload dbus.service ``` @@ -76,22 +121,26 @@ Then just execute the send command from above, the service will be autostarted b The password and cryptographic keys are created when registering and stored in the current users home directory: + $HOME/.config/signal/data/ + +For legacy users, the old config directory is used as a fallback: + $HOME/.config/textsecure/data/ ## Building This project uses [Gradle](http://gradle.org) for building and maintaining -dependencies. +dependencies. If you have a recent gradle version installed, you can replace `./gradlew` with `gradle` in the following steps. 1. Checkout the source somewhere on your filesystem with - git clone https://github.com/AsamK/textsecure-cli.git + git clone https://github.com/AsamK/signal-cli.git 2. Execute Gradle: ./gradlew build -3. Create shell wrapper in *build/install/textsecure-cli/bin*: +3. Create shell wrapper in *build/install/signal-cli/bin*: ./gradlew installDist @@ -104,8 +153,8 @@ If you use a version of the Oracle JRE and get an InvalidKeyException you need t ## License -This project uses libtextsecure-java from Open Whisper Systems: +This project uses libsignal-service-java from Open Whisper Systems: -https://github.com/WhisperSystems/libtextsecure-java +https://github.com/WhisperSystems/libsignal-service-java Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html