]> nmode's Git Repositories - signal-cli/blobdiff - README.md
git.nmode.ca / signal-cli / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Update ci.yml
[signal-cli] / README.md
diff --git a/README.md b/README.md
index dea9d145f92646904abc7357d3dc276597d48d2f..4bd49c17442defff73afcb692ac5995bd24ea743 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,120 +1,79 @@
 # signal-cli
 
 # signal-cli
 
-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 receiving messages signal-cli uses a [patched libsignal-service-java](https://github.com/AsamK/libsignal-service-java), because libsignal-service-java [does not yet support registering for the websocket support](https://github.com/WhisperSystems/libsignal-service-java/pull/5) nor [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.
-It is primarily intended to be used on servers to notify admins of important events. For this use-case, it has a dbus interface, that can be used to send messages from any programming language that has dbus bindings.
+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
-
-usage: signal-cli [-h] [-v] [--config CONFIG] [-u USERNAME | --dbus | --dbus-system] {link,addDevice,listDevices,removeDevice,register,verify,send,quitGroup,updateGroup,receive,daemon} ...
-
-* Register a number (with SMS verification)
+## Installation
 
 
-        signal-cli -u USERNAME register
+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 voice verification)
+System requirements:
+- at least Java Runtime Environment (JRE) 11
+- native libraries: libzkgroup, libsignal-client
 
 
-        signal-cli -u USERNAME register -v
+  Those are bundled for x86_64 Linux, 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
+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)
 
 
-        signal-cli -u USERNAME verify CODE
+## Usage
 
 
-* Send a message to one or more recipients
+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).
 
 
-        signal-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
+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.)
 
 
-* Pipe the message content from another process.
+* Register a number (with SMS verification)
 
 
-        uname -a | signal-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
+        signal-cli -u USERNAME register
         
         
-* Receive messages
+  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.
+  
+  Registering may require solving a CAPTCHA challenge: [Registration with captcha](https://github.com/AsamK/signal-cli/wiki/Registration-with-captcha)
 
 
-        signal-cli -u USERNAME receive
-
-* Groups
-
- * Create a group
-
-          signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
-
- * Update a group
-
-          signal-cli -u USERNAME updateGroup -g GROUP_ID -n "New group name"
+* 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
 
 
- * Leave a group
-
-          signal-cli -u USERNAME quitGroup -g GROUP_ID
-
- * Send a message to a group
+        signal-cli -u USERNAME verify CODE
 
 
-          signal-cli -u USERNAME send -m "This is a message" -g GROUP_ID
+* Send a message
 
 
-* Linking other devices (Provisioning)
+        signal-cli -u USERNAME send -m "This is a message" RECIPIENT
 
 
- * Connect to another device
+* Pipe the message content from another process.
 
 
-          signal-cli link -n "optional device name"
+        uname -a | signal-cli -u USERNAME send RECIPIENT
         
         
-        This shows a "tsdevice:/…" link, if you want to connect to another signal-cli instance, you can just use this link. If you want to link to and Android device, create a QR code with the link (e.g. with [qrencode](https://fukuchi.org/works/qrencode/)) and scan that in the Signal Android app.
-
- * Add another device
-
-          signal-cli -u USERNAME addDevice --uri "tsdevice:/…"
-          
-        The "tsdevice:/…" link is the one shown by the new signal-cli instance or contained in the QR code shown in Signal-Desktop or similar apps.
-        Only the master device (that was registered directly, not linked) can add new devices.
-
- * Manage linked devices
-
-          signal-cli -u USERNAME listDevices
-
-          signal-cli -u USERNAME removeDevice -d DEVICE_ID
-
-## DBus service
-
-signal-cli can run in daemon mode and provides an experimental dbus interface.
-For dbus support you need jni/unix-java.so installed on your system (Debian: libunixsocket-java ArchLinux: libmatthew-unix-java (AUR)).
-
-* Run in daemon mode (dbus session bus)
-
-          signal-cli -u USERNAME daemon
-
-* Send a message via dbus
-
-          signal-cli --dbus send -m "Message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
-
-### System bus
-
-To run on the system bus you need to take some additional steps.
-It’s advisable to run signal-cli as a separate unix user, the following steps assume you created a user named *signal-cli*.
-These steps, executed as root, should work on all distributions using systemd.
+* Receive messages
 
 
-```bash
-cp data/org.asamk.Signal.conf /etc/dbus-1/system.d/
-cp data/org.asamk.Signal.service /usr/share/dbus-1/system-services/
-cp data/signal.service /etc/systemd/system/
-sed -i -e "s|%dir%|<INSERT_INSTALL_PATH>|" -e "s|%number%|<INSERT_YOUR_NUMBER>|" /etc/systemd/system/signal.service
-systemctl daemon-reload
-systemctl enable signal.service
-systemctl reload dbus.service
-```
+        signal-cli -u USERNAME receive
 
 
-Then just execute the send command from above, the service will be autostarted by dbus the first time it is requested.
 
 ## 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/signal/data/
+`$XDG_DATA_HOME/signal-cli/data/` (`$HOME/.local/share/signal-cli/data/`)
 
 
-For legacy users, the old config directory is used as a fallback:
+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
 
@@ -132,8 +91,21 @@ 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
 
[GitHub/AsamK] signal-cli provides an unofficial commandline, JSON-RPC and dbus interface for the Signal messenger.

Codeberg
GitHub
GitLab
SourceHut