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

   1 # textsecure-cli
   2
   3 textsecure-cli is a commandline interface for [libtextsecure-java](https://github.com/WhisperSystems/libtextsecure-java). It supports registering, verifying, sending and receiving messages. However receiving messages currently doesn't work, because libtextsecure-java [does not yet support registering for the websocket support](https://github.com/WhisperSystems/libtextsecure-java/pull/5). For registering you need a phone number where you can receive SMS or incoming calls.
   4 It is primarily intended to be used on servers to notify admins of important events.
   5
   6 ## Usage
   7
   8 usage: textsecure-cli [-h] -u USERNAME {register,verify,send,receive} ...
   9
  10 * Register a number
  11
  12         textsecure-cli -u USERNAME register
  13
  14 * Register a number with voice verification
  15
  16         textsecure-cli -u USERNAME register -v
  17
  18 * Verify the number using the code received via SMS
  19
  20         textsecure-cli -u USERNAME verify CODE
  21
  22 * Send a message to one or more recipients
  23
  24         textsecure-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]]
  25
  26 * Pipe the message content from another process.
  27
  28         uname -a | textsecure-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
  29
  30 ## Storage
  31
  32 The password and cryptographic keys are created when registering and stored in the current users home directory.
  33
  34         $HOME/.config/textsecure/data/
  35
  36 ## Building
  37
  38 This project uses [Gradle](http://gradle.org) for building and maintaining
  39 dependencies.
  40
  41 1. Checkout the source somewhere on your filesystem with
  42
  43         git clone https://github.com/AsamK/textsecure-cli.git
  44
  45 2. Execute Gradle:
  46
  47         ./gradlew build
  48
  49 3. Create shell wrapper in *build/install/textsecure-cli/bin*:
  50
  51         ./gradlew installDist
  52
  53 4. Create tar file in *build/distributions*:
  54
  55         ./gradlew distTar
  56
  57 ## Troubleshooting
  58 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.
  59
  60 ## License
  61
  62 This project uses libtextsecure-java from Open Whisper Systems:
  63
  64 https://github.com/WhisperSystems/libtextsecure-java
  65
  66 Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html