X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/1be13392dabe6b4c3f79659f57990834a6e2c6d0..ce70a623c21a267679d59838d041f9bc1d486cd9:/README.md diff --git a/README.md b/README.md index fb0d9d88..b041b4a0 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,20 @@ # signal-cli 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). +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, that can be used to send messages from any programming language that has dbus bindings. +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. You need to have at least JRE 8 installed, to run signal-cli. +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). @@ -23,13 +30,17 @@ You can find further instructions on the Wiki: ## Usage -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.) +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). + +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.) * 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. + + 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. + + Registering may require solving a CAPTCHA challenge: [Registration with captcha](https://github.com/AsamK/signal-cli/wiki/Registration-with-captcha) * 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 @@ -42,24 +53,20 @@ Important: The USERNAME (your phone number) must include the country calling cod * Pipe the message content from another process. uname -a | signal-cli -u USERNAME send RECIPIENT - + * Receive messages signal-cli -u USERNAME receive -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). +**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: -`$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/ + $XDG_DATA_HOME/signal-cli/data/ + $HOME/.local/share/signal-cli/data/ ## Building @@ -74,16 +81,33 @@ dependencies. If you have a recent gradle version installed, you can replace `./ ./gradlew build -3. Create shell wrapper in *build/install/signal-cli/bin*: + 3a. Create shell wrapper in *build/install/signal-cli/bin*: ./gradlew installDist -4. Create tar file in *build/distributions*: + 3b. Create tar file in *build/distributions*: ./gradlew distTar -## Troubleshooting -If you use a version of the Oracle JRE and get an InvalidKeyException you need to enable unlimited strength crypto. See https://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters for instructions. + 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