X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/eabd361405a54a5b7122bf537cb299306f098e45..9912da9546718fc2fe5139b277e0d5263a85ef67:/README.md diff --git a/README.md b/README.md index f951669d..48ad7250 100644 --- a/README.md +++ b/README.md @@ -1,87 +1,70 @@ # 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. -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. +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 link to an existing Signal-Android/signal-cli instance, signal-cli uses a [patched libsignal-service-java](https://github.com/AsamK/libsignal-service-java), because libsignal-service-java does not yet support [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. +signal-cli 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/) and there is a [FreeBSD port](https://www.freshports.org/net-im/signal-cli) available as well. You need to have at least JRE 11 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/ +``` +You can find further instructions on the Wiki: +- [Quickstart](https://github.com/AsamK/signal-cli/wiki/Quickstart) +- [DBus Service](https://github.com/AsamK/signal-cli/wiki/DBus-service) ## Usage -usage: signal-cli [-h] [-u USERNAME] [-v] {register,verify,send,quitGroup,updateGroup,receive} ... +Important: The USERNAME (your phone number) must include the country calling code, i.e. the number must start with a "+" sign. (See [Wikipedia](https://en.wikipedia.org/wiki/List_of_country_calling_codes) for a list of all country codes.) * Register a number (with SMS verification) signal-cli -u USERNAME register + + You can register Signal using a land line number. In this case you can skip SMS verification process and jump directly to the voice call verification by adding the --voice switch at the end of above register command. -* Register a number (with voice verification) - - signal-cli -u USERNAME register -v - -* Verify the number using the code received via SMS or voice +* Verify the number using the code received via SMS or voice, optionally add `--pin PIN_CODE` if you've added a pin code to your account signal-cli -u USERNAME verify CODE -* Send a message to one or more recipients +* Send a message - signal-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 * Pipe the message content from another process. - uname -a | signal-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]] - -* Groups - - * Create a group - - signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]] - - * Update a group - - signal-cli -u USERNAME updateGroup -g GROUP_ID -n "New group name" - - * Send a message to a group - - signal-cli -u USERNAME send -m "This is a message" -g GROUP_ID - -## DBus service + uname -a | signal-cli -u USERNAME send RECIPIENT + +* Receive messages -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)). + signal-cli -u USERNAME receive -* Run in daemon mode (dbus session bus) - - signal-cli -u USERNAME daemon - -* Send a message via dbus - - 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 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.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 signal.service -systemctl reload dbus.service -``` - -Then just execute the send command from above, the service will be autostarted by dbus the first time it is requested. +For more information read the [man page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli.1.adoc) and the [wiki](https://github.com/AsamK/signal-cli/wiki). ## Storage The password and cryptographic keys are created when registering and stored in the current users home directory: +`$XDG_DATA_HOME/signal-cli/data/` (`$HOME/.local/share/signal-cli/data/`) + +For legacy users, the old config directories are used as a fallback: + $HOME/.config/signal/data/ + $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 @@ -104,8 +87,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