Convert Figma logo to code with AI

AsamK logosignal-cli

signal-cli provides an unofficial commandline, JSON-RPC and dbus interface for the Signal messenger.

3,130
295
3,130
51
View on GitHub

Top Related Projects

bbernhard's avatar

signal-cli-rest-api

1,273

Dockerized Signal Messenger REST API

Quick Overview

signal-cli is a command-line interface for the Signal messenger. It provides a way to interact with Signal's network from the command line or through scripts, allowing users to send and receive messages, manage contacts, and perform other Signal-related tasks without using the official mobile or desktop applications.

Pros

  • Enables automation of Signal messaging through scripts and command-line tools
  • Supports multiple accounts and device linking
  • Provides a way to use Signal on systems without graphical interfaces
  • Offers integration possibilities with other tools and services

Cons

  • Requires technical knowledge to set up and use effectively
  • May lack some features available in official Signal applications
  • Potential for misuse in automated messaging systems
  • Updates may lag behind official Signal protocol changes

Code Examples

  1. Sending a message:
signal-cli -u +1234567890 send -m "Hello, World!" +9876543210

This command sends a message "Hello, World!" from the account +1234567890 to +9876543210.

  1. Receiving messages:
signal-cli -u +1234567890 receive

This command receives and displays new messages for the account +1234567890.

  1. Listing contacts:
signal-cli -u +1234567890 listContacts

This command lists all contacts for the account +1234567890.

Getting Started

  1. Install signal-cli (example for Debian-based systems):

    sudo apt-get install signal-cli

  2. Register your phone number:

    signal-cli -u +1234567890 register

  3. Verify your phone number with the received code:

    signal-cli -u +1234567890 verify CODE

  4. Start using signal-cli commands, such as sending a message:

    signal-cli -u +1234567890 send -m "Hello from signal-cli" +9876543210

Replace +1234567890 with your phone number and +9876543210 with the recipient's number in the examples above.

Competitor Comparisons

bbernhard logo

signal-cli-rest-api

1,273

Dockerized Signal Messenger REST API

Pros of signal-cli-rest-api

  • Provides a RESTful API interface for Signal messaging
  • Easier integration with web applications and services
  • Containerized solution for simplified deployment

Cons of signal-cli-rest-api

  • Additional layer of abstraction may introduce latency
  • Potentially less flexible for advanced use cases
  • Depends on signal-cli, which may lead to version compatibility issues

Code Comparison

signal-cli (Java):

public class Main {
    public static void main(String[] args) {
        SignalService service = new SignalService();
        service.sendMessage("Hello, Signal!", "+1234567890");
    }
}

signal-cli-rest-api (HTTP request):

POST /v1/send
Content-Type: application/json

{
  "message": "Hello, Signal!",
  "number": "+1234567890"
}

Summary

signal-cli-rest-api builds upon signal-cli by providing a RESTful API interface, making it easier to integrate Signal messaging into web applications and services. It offers a containerized solution for simplified deployment but may introduce some latency due to the additional abstraction layer. signal-cli, on the other hand, provides direct access to Signal's functionality through a Java library, offering more flexibility for advanced use cases but requiring more setup and integration effort.

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

signal-cli

signal-cli is a commandline interface for the Signal messenger. It supports registering, verifying, sending and receiving messages. signal-cli uses a patched libsignal-service-java, extracted from the Signal-Android source code. 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 daemon mode with JSON-RPC interface (man page) and D-BUS interface (man page) . For the JSON-RPC interface there's also a simple example client, written in Rust.

Installation

You can build signal-cli yourself or use the provided binary files, which should work on Linux, macOS and Windows. There's also a docker image and some Linux packages provided by the community.

System requirements:

  • at least Java Runtime Environment (JRE) 21

  • native library: libsignal-client

    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

Install system-wide on Linux

See latest version.

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:

Usage

For a complete usage overview please read the man page and the 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 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

  • 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

    signal-cli -a ACCOUNT verify CODE

  • Send a message

    signal-cli -a ACCOUNT send -m "This is a message" RECIPIENT

  • Pipe the message content from another process.

    uname -a | signal-cli -a ACCOUNT send --message-from-stdin RECIPIENT

  • Receive messages

    signal-cli -a ACCOUNT receive

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:

$XDG_DATA_HOME/signal-cli/data/
$HOME/.local/share/signal-cli/data/

Building

This project uses Gradle 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

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

  2. Execute Gradle:

    ./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:

    ./gradlew run --args="--help"

Building a native binary with GraalVM (EXPERIMENTAL)

It is possible to build a native binary with GraalVM. This is still experimental and will not work in all situations.

  1. Install GraalVM and setup the environment

  2. Execute Gradle:

    ./gradlew nativeCompile

    The binary is available at build/native/nativeCompile/signal-cli

FAQ and Troubleshooting

For frequently asked questions and issues have a look at the wiki.

License

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

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

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