X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/76f27449dfea58bcd9a8bafd2f8d3c167e355a7c..ee12805d05f821780d5e9eec874f8c8081021934:/README.md diff --git a/README.md b/README.md index 3632d08d..093b0eef 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,28 @@ # 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 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. +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. ## Installation -You can [build signal-cli](#building) yourself, or use +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/), as well as -a [FreeBSD port](https://www.freshports.org/net-im/signal-cli) and -an [Alpine aport](https://pkgs.alpinelinux.org/packages?name=signal-cli). +Windows. There's also a [docker image and some Linux packages](https://github.com/AsamK/signal-cli/wiki/Binary-distributions) provided by the community. System requirements: - at least Java Runtime Environment (JRE) 17 - native library: libsignal-client - The native libs are bundled for x86_64 Linux (with recent enough glibc, see #643), Windows and MacOS. For other systems/architectures + The native libs are bundled for x86_64 Linux (with recent enough glibc), Windows and MacOS. 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 @@ -58,7 +55,7 @@ of all country codes.) 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 @@ -75,7 +72,7 @@ of all country codes.) * Pipe the message content from another process. - uname -a | signal-cli -a ACCOUNT send RECIPIENT + uname -a | signal-cli -a ACCOUNT send --message-from-stdin RECIPIENT * Receive messages