Remove deprecated --json parameter

[signal-cli] / README.md

diff --git a/README.md b/README.md
index 8790fc8d0835c12e6a116cd787aa8873bb9de484..86e8591bc62ec60ed3876fe0e7bfc33235d20de1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,66 +1,91 @@
-# textsecure-cli
+# signal-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 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.
-It is primarily intended to be used on servers to notify admins of important events.
+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.
+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).
+For registering you need a phone number where you can receive SMS or incoming calls.
+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 ([man page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli-dbus.5.adoc)), that can be used to send messages from any programming language that has dbus bindings.

 
 

-## Usage
+## Installation

 
 

-usage: textsecure-cli [-h] [-u USERNAME] [-v] {register,verify,send,quitGroup,updateGroup,receive} ...
+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.

 
 

-* Register a number (with SMS verification)
+System requirements:
+- at least Java Runtime Environment (JRE) 11
+- native libraries: libzkgroup, libsignal-client
+
+  Those are bundled for x86_64 Linux (with recent enough glibc, see #643), for other systems/architectures see: [Provide native lib for libsignal](https://github.com/AsamK/signal-cli/wiki/Provide-native-lib-for-libsignal)
+
+### Install system-wide on Linux
+See [latest version](https://github.com/AsamK/signal-cli/releases).
+```sh
+export VERSION=<latest version, format "x.y.z">
+wget https://github.com/AsamK/signal-cli/releases/download/v"${VERSION}"/signal-cli-"${VERSION}".tar.gz
+sudo tar xf signal-cli-"${VERSION}".tar.gz -C /opt
+sudo ln -sf /opt/signal-cli-"${VERSION}"/bin/signal-cli /usr/local/bin/
+```
+You can find further instructions on the Wiki:
+- [Quickstart](https://github.com/AsamK/signal-cli/wiki/Quickstart)
+- [DBus Service](https://github.com/AsamK/signal-cli/wiki/DBus-service)

 
 

-        textsecure-cli -u USERNAME register
+## Usage

 
 

-* Register a number (with voice verification)
+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).

 
 

-        textsecure-cli -u USERNAME register -v
+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.)

 
 

-* Verify the number using the code received via SMS or voice
+* Register a number (with SMS verification)

 
 

-        textsecure-cli -u USERNAME verify CODE
+        signal-cli -u USERNAME register

 
 

-* Send a message to one or more recipients
+  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.

 
 

-        textsecure-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
+  Registering may require solving a CAPTCHA challenge: [Registration with captcha](https://github.com/AsamK/signal-cli/wiki/Registration-with-captcha)

 
 

-* Pipe the message content from another process.
+* 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

 
 

-        uname -a | textsecure-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
+        signal-cli -u USERNAME verify CODE

 
 

-* Groups
+* Send a message

 
 

- * Create a group
+        signal-cli -u USERNAME send -m "This is a message" RECIPIENT

 
 

-          textsecure-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
+* Pipe the message content from another process.

 
 

- * Update a group
+        uname -a | signal-cli -u USERNAME send RECIPIENT

 
 

-          textsecure-cli -u USERNAME updateGroup -g GROUP_ID -n "New group name"
+* Receive messages

 
 

- * Send a message to a group
+        signal-cli -u USERNAME receive

 
 

-          textsecure-cli -u USERNAME send -m "This is a message" -g GROUP_ID
+**Hint**: The Signal protocol expects that incoming messages are regularly received (using `daemon` or `receive` command).
+This is required for the encryption to work efficiently and for getting updates to groups, expiration timer and other features.

 
 ## Storage
 
 The password and cryptographic keys are created when registering and stored in the current users home directory:
 
 
 ## Storage
 
 The password and cryptographic keys are created when registering and stored in the current users home directory:
 

+        $XDG_DATA_HOME/signal-cli/data/
+        $HOME/.local/share/signal-cli/data/
+
+For legacy users, the old config directories are used as a fallback:
+
+        $HOME/.config/signal/data/

         $HOME/.config/textsecure/data/
 
 ## Building
 
 This project uses [Gradle](http://gradle.org) for building and maintaining
         $HOME/.config/textsecure/data/
 
 ## Building
 
 This project uses [Gradle](http://gradle.org) for building and maintaining

-dependencies.
+dependencies. If you have a recent gradle version installed, you can replace `./gradlew` with `gradle` in the following steps.

 
 1. Checkout the source somewhere on your filesystem with
 
 
 1. Checkout the source somewhere on your filesystem with
 

-        git clone https://github.com/AsamK/textsecure-cli.git
+        git clone https://github.com/AsamK/signal-cli.git

 
 2. Execute Gradle:
 
         ./gradlew build
 
 
 2. Execute Gradle:
 
         ./gradlew build
 

-3. Create shell wrapper in *build/install/textsecure-cli/bin*:
+3. Create shell wrapper in *build/install/signal-cli/bin*:

 
         ./gradlew installDist
 
 
         ./gradlew installDist
 


@@ -68,13 +93,26 @@ dependencies.
 
         ./gradlew distTar
 
 
         ./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.
+### Building a native binary with GraalVM (EXPERIMENTAL)
+
+It is possible to build a native binary with [GraalVM](https://www.graalvm.org).
+This is still experimental and will not work in all situations.
+
+1. [Install GraalVM and setup the enviroment](https://www.graalvm.org/docs/getting-started/#install-graalvm)
+2. [Install prerequisites](https://www.graalvm.org/reference-manual/native-image/#prerequisites)
+3. Execute Gradle:
+
+        ./gradlew assembleNativeImage
+
+   The binary is available at *build/native-image/signal-cli*
+
+## FAQ and Troubleshooting
+For frequently asked questions and issues have a look at the [wiki](https://github.com/AsamK/signal-cli/wiki/FAQ)

 
 ## License
 
 
 ## License
 

-This project uses libtextsecure-java from Open Whisper Systems:
+This project uses libsignal-service-java from Open Whisper Systems:

 
 

-https://github.com/WhisperSystems/libtextsecure-java
+https://github.com/WhisperSystems/libsignal-service-java

 
 Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html
 
 Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html