X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/4e83ea0f85d10f8cbe7c0afcc1c77b0d4b4a7a8c..ce70a623c21a267679d59838d041f9bc1d486cd9:/README.md diff --git a/README.md b/README.md index f5b1d1c8..b041b4a0 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,118 @@ -# 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 doesn't work, 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. -It is primarily intented 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 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 linked 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 ([man page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli-dbus.5.adoc)), that can be used to send messages from any programming language that has dbus bindings. +It also has a JSON-RPC based interface, see the [documentation](https://github.com/AsamK/signal-cli/wiki/JSON-RPC-service) for more information. + +## 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. + +System requirements: +- at least Java Runtime Environment (JRE) 17 +- native libraries: libzkgroup, libsignal-client + + Those are bundled for x86_64 Linux (with recent enough glibc, see #643), for other systems/architectures see: [Provide native lib for libsignal](https://github.com/AsamK/signal-cli/wiki/Provide-native-lib-for-libsignal) + +### 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: textsecure-cli [-h] -u USERNAME {register,verify,send,receive} ... +For a complete usage overview please 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). -* Register a number +Important: The USERNAME is your phone number in international format and must include the country calling code. Hence it should start with a "+" sign. (See [Wikipedia](https://en.wikipedia.org/wiki/List_of_country_calling_codes) for a list of all country codes.) - textsecure-cli -u USERNAME register +* Register a number (with SMS verification) -* Verify the number using the code received via SMS + signal-cli -u USERNAME register - textsecure-cli -u USERNAME verify CODE + 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. -* Send a message to one or more recipients + Registering may require solving a CAPTCHA challenge: [Registration with captcha](https://github.com/AsamK/signal-cli/wiki/Registration-with-captcha) - textsecure-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] +* 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 + + signal-cli -u USERNAME send -m "This is a message" RECIPIENT * Pipe the message content from another process. - uname -a | textsecure-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]] + uname -a | signal-cli -u USERNAME send RECIPIENT + +* Receive messages + + signal-cli -u USERNAME receive + +**Hint**: The Signal protocol expects that incoming messages are regularly received (using `daemon` or `receive` command). +This is required for the encryption to work efficiently and for getting updates to groups, expiration timer and other features. ## Storage -The password and cryptographic keys are created when registering and stored in the current users home directory. +The password and cryptographic keys are created when registering and stored in the current users home directory: - $HOME/.config/textsecure/data/ + $XDG_DATA_HOME/signal-cli/data/ + $HOME/.local/share/signal-cli/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 wit +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*: + 3a. Create shell wrapper in *build/install/signal-cli/bin*: - ./gradlew installApp + ./gradlew installDist -4. Create tar file: + 3b. Create tar file in *build/distributions*: ./gradlew distTar + 3c. Compile and run signal-cli: + + ./gradlew run --args="--help" + +### Building a native binary with GraalVM (EXPERIMENTAL) + +It is possible to build a native binary with [GraalVM](https://www.graalvm.org). +This is still experimental and will not work in all situations. + +1. [Install GraalVM and setup the enviroment](https://www.graalvm.org/docs/getting-started/#install-graalvm) +2. [Install prerequisites](https://www.graalvm.org/reference-manual/native-image/#prerequisites) +3. Execute Gradle: + + ./gradlew nativeCompile + + The binary is available at *build/native/nativeCompile/signal-cli* + +## FAQ and Troubleshooting +For frequently asked questions and issues have a look at the [wiki](https://github.com/AsamK/signal-cli/wiki/FAQ) + ## 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