X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/95278a95ce4cb52b0f4c42f79a8939b413c9eed1..1bae3ba6f04e608724ea55feb65d3909c3536b79:/README.md diff --git a/README.md b/README.md index e2a3145e..617742c2 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,24 @@ # signal-cli -signal-cli is a commandline interface for [libtextsecure-java](https://github.com/WhisperSystems/libtextsecure-java). It supports registering, verifying, sending and receiving messages. To be able to receiving messages signal-cli uses a [patched libtextsecure-java](https://github.com/AsamK/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. +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 receive 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 +See [latest version](https://github.com/AsamK/signal-cli/releases). +```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: signal-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,listIdentities,trust,receive,daemon} ... * Register a number (with SMS verification) @@ -26,6 +39,10 @@ usage: signal-cli [-h] [-u USERNAME] [-v] {register,verify,send,quitGroup,update * Pipe the message content from another process. uname -a | signal-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]] + +* Receive messages + + signal-cli -u USERNAME receive * Groups @@ -35,12 +52,59 @@ usage: signal-cli [-h] [-u USERNAME] [-v] {register,verify,send,quitGroup,update * Update a group - signal-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 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 + +* Manage trusted keys + + * View all known keys + + signal-cli -u USERNAME listIdentities + + * View known keys of one number + + signal-cli -u USERNAME listIdentities -n NUMBER + + * Trust new key, after having verified it + + signal-cli -u USERNAME trust -v FINGER_PRINT NUMBER + + * Trust new key, without having verified it. Only use this if you don't care about security + + signal-cli -u USERNAME trust -a NUMBER + ## DBus service signal-cli can run in daemon mode and provides an experimental dbus interface. @@ -85,7 +149,7 @@ For legacy users, the old config directory is used as a fallback: ## 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 @@ -108,8 +172,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