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 only works with a patched libtextsecure-java, 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] [-v] {register,verify,send,quitGroup,updateGroup,receive} ...
   9
  10 * Register a number (with SMS verification)
  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 or voice
  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 ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
  25
  26 * Pipe the message content from another process.
  27
  28         uname -a | textsecure-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
  29
  30 * Groups
  31
  32  * Create a group
  33
  34           textsecure-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
  35
  36  * Update a group
  37
  38           textsecure-cli -u USERNAME updateGroup -g GROUP_ID -n "New group name"
  39
  40  * Send a message to a group
  41
  42           textsecure-cli -u USERNAME send -m "This is a message" -g GROUP_ID
  43
  44 ## Storage
  45
  46 The password and cryptographic keys are created when registering and stored in the current users home directory:
  47
  48         $HOME/.config/textsecure/data/
  49
  50 ## Building
  51
  52 This project uses [Gradle](http://gradle.org) for building and maintaining
  53 dependencies.
  54
  55 1. Checkout the source somewhere on your filesystem with
  56
  57         git clone https://github.com/AsamK/textsecure-cli.git
  58
  59 2. Execute Gradle:
  60
  61         ./gradlew build
  62
  63 3. Create shell wrapper in *build/install/textsecure-cli/bin*:
  64
  65         ./gradlew installDist
  66
  67 4. Create tar file in *build/distributions*:
  68
  69         ./gradlew distTar
  70
  71 ## Troubleshooting
  72 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.
  73
  74 ## License
  75
  76 This project uses libtextsecure-java from Open Whisper Systems:
  77
  78 https://github.com/WhisperSystems/libtextsecure-java
  79
  80 Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html