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

   1 # signal-cli
   2
   3 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.
   4 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).
   5 For registering you need a phone number where you can receive SMS or incoming calls.
   6 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.
   7
   8 ## Installation
   9
  10 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 11 installed, to run signal-cli.
  11
  12 ### Install system-wide on Linux
  13 See [latest version](https://github.com/AsamK/signal-cli/releases).
  14 ```sh
  15 export VERSION=<latest version, format "x.y.z">
  16 wget https://github.com/AsamK/signal-cli/releases/download/v"${VERSION}"/signal-cli-"${VERSION}".tar.gz
  17 sudo tar xf signal-cli-"${VERSION}".tar.gz -C /opt
  18 sudo ln -sf /opt/signal-cli-"${VERSION}"/bin/signal-cli /usr/local/bin/
  19 ```
  20 You can find further instructions on the Wiki:
  21 - [Quickstart](https://github.com/AsamK/signal-cli/wiki/Quickstart)
  22 - [DBus Service](https://github.com/AsamK/signal-cli/wiki/DBus-service)
  23
  24 ## Usage
  25
  26 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).
  27
  28 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.)
  29
  30 * Register a number (with SMS verification)
  31
  32         signal-cli -u USERNAME register
  33
  34   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.
  35
  36 * 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
  37
  38         signal-cli -u USERNAME verify CODE
  39
  40 * Send a message
  41
  42         signal-cli -u USERNAME send -m "This is a message" RECIPIENT
  43
  44 * Pipe the message content from another process.
  45
  46         uname -a | signal-cli -u USERNAME send RECIPIENT
  47
  48 * Receive messages
  49
  50         signal-cli -u USERNAME receive
  51
  52
  53 ## Storage
  54
  55 The password and cryptographic keys are created when registering and stored in the current users home directory:
  56
  57 `$XDG_DATA_HOME/signal-cli/data/` (`$HOME/.local/share/signal-cli/data/`)
  58
  59 For legacy users, the old config directories are used as a fallback:
  60
  61         $HOME/.config/signal/data/
  62
  63         $HOME/.config/textsecure/data/
  64
  65 ## Building
  66
  67 This project uses [Gradle](http://gradle.org) for building and maintaining
  68 dependencies. If you have a recent gradle version installed, you can replace `./gradlew` with `gradle` in the following steps.
  69
  70 1. Checkout the source somewhere on your filesystem with
  71
  72         git clone https://github.com/AsamK/signal-cli.git
  73
  74 2. Execute Gradle:
  75
  76         ./gradlew build
  77
  78 3. Create shell wrapper in *build/install/signal-cli/bin*:
  79
  80         ./gradlew installDist
  81
  82 4. Create tar file in *build/distributions*:
  83
  84         ./gradlew distTar
  85
  86 ## Troubleshooting
  87 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.
  88
  89 ## License
  90
  91 This project uses libsignal-service-java from Open Whisper Systems:
  92
  93 https://github.com/WhisperSystems/libsignal-service-java
  94
  95 Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html