X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/27c08a56fe2a64e345f0076a3e1d63c9f0fc4b77..63aec5cb95257c9c013093f9db425a9f42443c4c:/README.md?ds=inline diff --git a/README.md b/README.md index 897b9fd1..dcd69a0c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # textsecure-cli -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. -It is primarily intented to be used on servers to notify admins of important events. +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. +It is primarily intended to be used on servers to notify admins of important events. ## Usage @@ -11,6 +11,10 @@ usage: textsecure-cli [-h] -u USERNAME {register,verify,send,receive} ... textsecure-cli -u USERNAME register +* Register a number with voice verification + + textsecure-cli -u USERNAME register -v + * Verify the number using the code received via SMS textsecure-cli -u USERNAME verify CODE @@ -34,7 +38,7 @@ The password and cryptographic keys are created when registering and stored in t This project uses [Gradle](http://gradle.org) for building and maintaining dependencies. -1. Checkout the source somewhere on your filesystem wit +1. Checkout the source somewhere on your filesystem with git clone https://github.com/AsamK/textsecure-cli.git @@ -44,12 +48,15 @@ dependencies. 3. Create shell wrapper in *build/install/textsecure-cli/bin*: - ./gradlew installApp + ./gradlew installDist 4. Create tar file in *build/distributions*: ./gradlew distTar +## Troubleshooting +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. + ## License This project uses libtextsecure-java from Open Whisper Systems: