# 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 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 a commandline interface for the [Signal messenger](https://signal.org/).
+It supports registering, verifying, sending and receiving messages.
+signal-cli uses a [patched libsignal-service-java](https://github.com/Turasa/libsignal-service-java),
+extracted from the [Signal-Android source code](https://github.com/signalapp/Signal-Android/tree/main/libsignal/service).
+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 daemon mode with D-BUS
-interface ([man page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli-dbus.5.adoc)) and JSON-RPC interface ([documentation](https://github.com/AsamK/signal-cli/wiki/JSON-RPC-service)). For the JSON-RPC interface there's also a simple [example client](https://github.com/AsamK/signal-cli/tree/master/client), written in Rust.
+signal-cli is primarily intended to be used on servers to notify admins of important events.
+For this use-case, it has a daemon mode with JSON-RPC interface ([man page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli-jsonrpc.5.adoc))
+and D-BUS interface ([man page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli-dbus.5.adoc)) .
+For the JSON-RPC interface there's also a simple [example client](https://github.com/AsamK/signal-cli/tree/master/client), written in Rust.
## Installation
System requirements:
-- at least Java Runtime Environment (JRE) 17
+- at least Java Runtime Environment (JRE) 21
- native library: libsignal-client
The native libs are bundled for x86_64 Linux (with recent enough glibc), Windows and MacOS. For other
```sh
export VERSION=<latest version, format "x.y.z">
-wget https://github.com/AsamK/signal-cli/releases/download/v"${VERSION}"/signal-cli-"${VERSION}"-Linux.tar.gz
-sudo tar xf signal-cli-"${VERSION}"-Linux.tar.gz -C /opt
+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
* Register a number (with SMS verification)
- signal-cli -a ACCOUNT register
+ signal-cli -a ACCOUNT register
- You can register Signal using a land line number. In this case you can skip SMS verification process and jump directly
+ You can register Signal using a landline 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
* 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 -a ACCOUNT verify CODE
+ signal-cli -a ACCOUNT verify CODE
* Send a message
- signal-cli -a ACCOUNT send -m "This is a message" RECIPIENT
+ ```sh
+ signal-cli -a ACCOUNT send -m "This is a message" RECIPIENT
+ ```
* Pipe the message content from another process.
- uname -a | signal-cli -a ACCOUNT send --message-from-stdin RECIPIENT
+ uname -a | signal-cli -a ACCOUNT send --message-from-stdin RECIPIENT
* Receive messages
- signal-cli -a ACCOUNT receive
+ signal-cli -a ACCOUNT 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
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/
+ $XDG_DATA_HOME/signal-cli/data/
+ $HOME/.local/share/signal-cli/data/
## Building
1. Checkout the source somewhere on your filesystem with
- git clone https://github.com/AsamK/signal-cli.git
+ git clone https://github.com/AsamK/signal-cli.git
2. Execute Gradle:
- ./gradlew build
+ ./gradlew build
2a. Create shell wrapper in *build/install/signal-cli/bin*:
- ./gradlew installDist
+ ./gradlew installDist
2b. Create tar file in *build/distributions*:
- ./gradlew distTar
+ ./gradlew distTar
2c. Create a fat tar file in *build/libs/signal-cli-fat*:
- ./gradlew fatJar
+ ./gradlew fatJar
2d. Compile and run signal-cli:
- ./gradlew run --args="--help"
+ ```sh
+ ./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:
+1. [Install GraalVM and setup the environment](https://www.graalvm.org/docs/getting-started/#install-graalvm)
+2. Execute Gradle:
- ./gradlew nativeCompile
+ ./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)
+For frequently asked questions and issues have a look at the [wiki](https://github.com/AsamK/signal-cli/wiki/FAQ).
## License
git.nmode.ca / signal-cli / blobdiff
