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/). You need to have at least JRE 7 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 - [Install on Ubuntu](https://github.com/AsamK/signal-cli/wiki/HowToUbuntu)
  22 - [DBus Service](https://github.com/AsamK/signal-cli/wiki/DBus-service)
  23
  24 ## Usage
  25
  26 Important: The USERNAME (your phone number) must include the country calling code, i.e. the number must start with a "+" sign. (See [Wikipedia](https://en.wikipedia.org/wiki/List_of_country_calling_codes) for a list of all country codes.
  27
  28 * Register a number (with SMS verification)
  29
  30         signal-cli -u USERNAME register
  31
  32 * Verify the number using the code received via SMS or voice
  33
  34         signal-cli -u USERNAME verify CODE
  35
  36 * Send a message
  37
  38         signal-cli -u USERNAME send -m "This is a message" RECIPIENT
  39
  40 * Pipe the message content from another process.
  41
  42         uname -a | signal-cli -u USERNAME send RECIPIENT
  43
  44 * Receive messages
  45
  46         signal-cli -u USERNAME receive
  47
  48 For more information 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).
  49
  50 ## Storage
  51
  52 The password and cryptographic keys are created when registering and stored in the current users home directory:
  53
  54         $HOME/.config/signal/data/
  55
  56 For legacy users, the old config directory is used as a fallback:
  57
  58         $HOME/.config/textsecure/data/
  59
  60 ## Building
  61
  62 This project uses [Gradle](http://gradle.org) for building and maintaining
  63 dependencies. If you have a recent gradle version installed, you can replace `./gradlew` with `gradle` in the following steps.
  64
  65 1. Checkout the source somewhere on your filesystem with
  66
  67         git clone https://github.com/AsamK/signal-cli.git
  68
  69 2. Execute Gradle:
  70
  71         ./gradlew build
  72
  73 3. Create shell wrapper in *build/install/signal-cli/bin*:
  74
  75         ./gradlew installDist
  76
  77 4. Create tar file in *build/distributions*:
  78
  79         ./gradlew distTar
  80
  81 ## Troubleshooting
  82 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.
  83
  84 ## License
  85
  86 This project uses libsignal-service-java from Open Whisper Systems:
  87
  88 https://github.com/WhisperSystems/libsignal-service-java
  89
  90 Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html