X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/d3a4a3a99e69f210f42979a01d371bbbe0ba55ec..ca52c0103136bc1f0cb140c33e81ff17d47aec2e:/README.md diff --git a/README.md b/README.md index 4bd49c17..9658dcba 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # 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 ([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. @@ -13,7 +13,7 @@ System requirements: - at least Java Runtime Environment (JRE) 11 - native libraries: libzkgroup, libsignal-client - Those are bundled for x86_64 Linux, for other systems/architectures see: [Provide native lib for libsignal](https://github.com/AsamK/signal-cli/wiki/Provide-native-lib-for-libsignal) + 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). @@ -36,9 +36,9 @@ Important: The USERNAME is your phone number in international format and must in * 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. - + 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 @@ -52,23 +52,20 @@ Important: The USERNAME is your phone number in international format and must in * Pipe the message content from another process. 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: -`$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 @@ -101,7 +98,7 @@ This is still experimental and will not work in all situations. 3. Execute Gradle: ./gradlew assembleNativeImage - + The binary is available at *build/native-image/signal-cli* ## FAQ and Troubleshooting