X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/39687f9d87774a824be4765d80a635475f8215f1..d78551564b8ce87615cfb575aa2eaab61644c142:/README.md?ds=sidebyside diff --git a/README.md b/README.md index dea9d145..6da7b477 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,18 @@ 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: signal-cli [-h] [-v] [--config CONFIG] [-u USERNAME | --dbus | --dbus-system] {link,addDevice,listDevices,removeDevice,register,verify,send,quitGroup,updateGroup,receive,daemon} ... @@ -39,7 +51,11 @@ usage: signal-cli [-h] [-v] [--config CONFIG] [-u USERNAME | --dbus | --dbus-sys * 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 @@ -114,7 +130,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