Remove jetbrains annotation

[signal-cli] / README.md

diff --git a/README.md b/README.md
index 8790fc8d0835c12e6a116cd787aa8873bb9de484..b546a62c53764173e189694da7090b419a53764c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,80 +1,148 @@
-# 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 the [Signal messenger](https://signal.org/).
+It supports registering, verifying, sending and receiving messages.
+signal-cli uses a [patched libsignal-service-java](https://github.com/Turasa/libsignal-service-java),
+extracted from the [Signal-Android source code](https://github.com/signalapp/Signal-Android/tree/main/libsignal/service).
+For registering you need a phone number where you can receive SMS or incoming calls.

 
 

-## Usage
+signal-cli is primarily intended to be used on servers to notify admins of important events.
+For this use-case, it has a daemon mode with JSON-RPC interface ([man page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli-jsonrpc.5.adoc))
+and D-BUS interface ([man page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli-dbus.5.adoc)) .
+For the JSON-RPC interface there's also a simple [example client](https://github.com/AsamK/signal-cli/tree/master/client), written in Rust.

 
 

-usage: textsecure-cli [-h] [-u USERNAME] [-v] {register,verify,send,quitGroup,updateGroup,receive} ...
+## Installation

 
 

-* Register a number (with SMS verification)
+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. There's also a [docker image and some Linux packages](https://github.com/AsamK/signal-cli/wiki/Binary-distributions) provided by the community.

 
 

-        textsecure-cli -u USERNAME register
+System requirements:

 
 

-* Register a number (with voice verification)
+- at least Java Runtime Environment (JRE) 17
+- native library: libsignal-client

 
 

-        textsecure-cli -u USERNAME register -v
+  The native libs are bundled for x86_64 Linux (with recent enough glibc), Windows and MacOS. For other
+  systems/architectures
+  see: [Provide native lib for libsignal](https://github.com/AsamK/signal-cli/wiki/Provide-native-lib-for-libsignal)

 
 

-* Verify the number using the code received via SMS or voice
+### Install system-wide on Linux

 
 

-        textsecure-cli -u USERNAME verify CODE
+See [latest version](https://github.com/AsamK/signal-cli/releases).

 
 

-* Send a message to one or more recipients
+```sh
+export VERSION=<latest version, format "x.y.z">
+wget https://github.com/AsamK/signal-cli/releases/download/v"${VERSION}"/signal-cli-"${VERSION}"-Linux.tar.gz
+sudo tar xf signal-cli-"${VERSION}"-Linux.tar.gz -C /opt
+sudo ln -sf /opt/signal-cli-"${VERSION}"/bin/signal-cli /usr/local/bin/
+```

 
 

-        textsecure-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
+You can find further instructions on the Wiki:

 
 

-* Pipe the message content from another process.
+- [Quickstart](https://github.com/AsamK/signal-cli/wiki/Quickstart)
+
+## Usage
+
+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).
+
+Important: The ACCOUNT 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.)
+
+* Register a number (with SMS verification)
+
+      signal-cli -a ACCOUNT register
+
+  You can register Signal using a landline 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.
+
+  Registering may require solving a CAPTCHA
+  challenge: [Registration with captcha](https://github.com/AsamK/signal-cli/wiki/Registration-with-captcha)

 
 

-        uname -a | textsecure-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
+* 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

 
 

-* Groups
+      signal-cli -a ACCOUNT verify CODE

 
 

- * Create a group
+* Send a message

 
 

-          textsecure-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
+     ```sh
+     signal-cli -a ACCOUNT send -m "This is a message" RECIPIENT
+     ```

 
 

- * Update a group
+* Pipe the message content from another process.
+
+      uname -a | signal-cli -a ACCOUNT send --message-from-stdin RECIPIENT

 
 

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

 
 

- * Send a message to a group
+      signal-cli -a ACCOUNT 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:
 

-        $HOME/.config/textsecure/data/
+    $XDG_DATA_HOME/signal-cli/data/
+    $HOME/.local/share/signal-cli/data/

 
 ## Building
 
 
 ## Building
 

-This project uses [Gradle](http://gradle.org) for building and maintaining
-dependencies.
+This project uses [Gradle](http://gradle.org) for building and maintaining 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:
 
 
 2. Execute Gradle:
 

-        ./gradlew build
+       ./gradlew build
+
+   2a. Create shell wrapper in *build/install/signal-cli/bin*:
+
+       ./gradlew installDist
+
+   2b. Create tar file in *build/distributions*:
+
+       ./gradlew distTar
+
+   2c. Create a fat tar file in *build/libs/signal-cli-fat*:
+
+       ./gradlew fatJar
+
+   2d. Compile and run signal-cli:
+
+      ```sh
+      ./gradlew run --args="--help"
+      ```
+
+### 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.

 
 

-3. Create shell wrapper in *build/install/textsecure-cli/bin*:
+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 installDist
+       ./gradlew nativeCompile

 
 

-4. Create tar file in *build/distributions*:
+   The binary is available at *build/native/nativeCompile/signal-cli*

 
 

-        ./gradlew distTar
+## FAQ and Troubleshooting

 
 

-## 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.
+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