nmode's Git Repositories - signal-cli/blob - README.md

   1 # signal-cli
   2
   3 signal-cli is a commandline interface
   4 for [libsignal-service-java](https://github.com/WhisperSystems/libsignal-service-java). It supports registering,
   5 verifying, sending and receiving messages. To be able to link to an existing Signal-Android/signal-cli instance,
   6 signal-cli uses a [patched libsignal-service-java](https://github.com/AsamK/libsignal-service-java), because
   7 libsignal-service-java does not yet
   8 support [provisioning as a linked device](https://github.com/WhisperSystems/libsignal-service-java/pull/21). For
   9 registering you need a phone number where you can receive SMS or incoming calls. signal-cli is primarily intended to be
  10 used on servers to notify admins of important events. For this use-case, it has a dbus
  11 interface ([man page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli-dbus.5.adoc)), that can be used to
  12 send messages from any programming language that has dbus bindings. It also has a JSON-RPC based interface, see
  13 the [documentation](https://github.com/AsamK/signal-cli/wiki/JSON-RPC-service) for more information.
  14
  15 ## Installation
  16
  17 You can [build signal-cli](#building) yourself, or use
  18 the [provided binary files](https://github.com/AsamK/signal-cli/releases/latest), which should work on Linux, macOS and
  19 Windows. For Arch Linux there is also a [package in AUR](https://aur.archlinux.org/packages/signal-cli/), as well as
  20 a [FreeBSD port](https://www.freshports.org/net-im/signal-cli) and
  21 an [Alpine aport](https://pkgs.alpinelinux.org/packages?name=signal-cli).
  22
  23 System requirements:
  24
  25 - at least Java Runtime Environment (JRE) 17
  26 - native library: libsignal-client
  27
  28   The native libs are bundled for x86_64 Linux (with recent enough glibc, see #643), Windows and MacOS. For other
  29   systems/architectures
  30   see: [Provide native lib for libsignal](https://github.com/AsamK/signal-cli/wiki/Provide-native-lib-for-libsignal)
  31
  32 ### Install system-wide on Linux
  33
  34 See [latest version](https://github.com/AsamK/signal-cli/releases).
  35
  36 ```sh
  37 export VERSION=<latest version, format "x.y.z">
  38 wget https://github.com/AsamK/signal-cli/releases/download/v"${VERSION}"/signal-cli-"${VERSION}"-Linux.tar.gz
  39 sudo tar xf signal-cli-"${VERSION}"-Linux.tar.gz -C /opt
  40 sudo ln -sf /opt/signal-cli-"${VERSION}"/bin/signal-cli /usr/local/bin/
  41 ```
  42
  43 You can find further instructions on the Wiki:
  44
  45 - [Quickstart](https://github.com/AsamK/signal-cli/wiki/Quickstart)
  46 - [DBus Service](https://github.com/AsamK/signal-cli/wiki/DBus-service)
  47
  48 ## Usage
  49
  50 For a complete usage overview please read
  51 the [man page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli.1.adoc) and
  52 the [wiki](https://github.com/AsamK/signal-cli/wiki).
  53
  54 Important: The ACCOUNT is your phone number in international format and must include the country calling code. Hence it
  55 should start with a "+" sign. (See [Wikipedia](https://en.wikipedia.org/wiki/List_of_country_calling_codes) for a list
  56 of all country codes.)
  57
  58 * Register a number (with SMS verification)
  59
  60         signal-cli -a ACCOUNT register
  61
  62   You can register Signal using a land line number. In this case you can skip SMS verification process and jump directly
  63   to the voice call verification by adding the `--voice` switch at the end of above register command.
  64
  65   Registering may require solving a CAPTCHA
  66   challenge: [Registration with captcha](https://github.com/AsamK/signal-cli/wiki/Registration-with-captcha)
  67
  68 * Verify the number using the code received via SMS or voice, optionally add `--pin PIN_CODE` if you've added a pin code
  69   to your account
  70
  71         signal-cli -a ACCOUNT verify CODE
  72
  73 * Send a message
  74
  75         signal-cli -a ACCOUNT send -m "This is a message" RECIPIENT
  76
  77 * Pipe the message content from another process.
  78
  79         uname -a | signal-cli -a ACCOUNT send --message-from-stdin RECIPIENT
  80
  81 * Receive messages
  82
  83         signal-cli -a ACCOUNT receive
  84
  85 **Hint**: The Signal protocol expects that incoming messages are regularly received (using `daemon` or `receive`
  86 command). This is required for the encryption to work efficiently and for getting updates to groups, expiration timer
  87 and other features.
  88
  89 ## Storage
  90
  91 The password and cryptographic keys are created when registering and stored in the current users home directory:
  92
  93         $XDG_DATA_HOME/signal-cli/data/
  94         $HOME/.local/share/signal-cli/data/
  95
  96 ## Building
  97
  98 This project uses [Gradle](http://gradle.org) for building and maintaining dependencies. If you have a recent gradle
  99 version installed, you can replace `./gradlew` with `gradle` in the following steps.
 100
 101 1. Checkout the source somewhere on your filesystem with
 102
 103         git clone https://github.com/AsamK/signal-cli.git
 104
 105 2. Execute Gradle:
 106
 107         ./gradlew build
 108
 109    2a. Create shell wrapper in *build/install/signal-cli/bin*:
 110
 111         ./gradlew installDist
 112
 113    2b. Create tar file in *build/distributions*:
 114
 115         ./gradlew distTar
 116
 117    2c. Create a fat tar file in *build/libs/signal-cli-fat*:
 118
 119         ./gradlew fatJar
 120
 121    2d. Compile and run signal-cli:
 122
 123         ./gradlew run --args="--help"
 124
 125 ### Building a native binary with GraalVM (EXPERIMENTAL)
 126
 127 It is possible to build a native binary with [GraalVM](https://www.graalvm.org). This is still experimental and will not
 128 work in all situations.
 129
 130 1. [Install GraalVM and setup the enviroment](https://www.graalvm.org/docs/getting-started/#install-graalvm)
 131 2. [Install prerequisites](https://www.graalvm.org/reference-manual/native-image/#prerequisites)
 132 3. Execute Gradle:
 133
 134         ./gradlew nativeCompile
 135
 136    The binary is available at *build/native/nativeCompile/signal-cli*
 137
 138 ## FAQ and Troubleshooting
 139
 140 For frequently asked questions and issues have a look at the [wiki](https://github.com/AsamK/signal-cli/wiki/FAQ)
 141
 142 ## License
 143
 144 This project uses libsignal-service-java from Open Whisper Systems:
 145
 146 https://github.com/WhisperSystems/libsignal-service-java
 147
 148 Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html