{"id":15027007,"url":"https://github.com/asamk/signal-cli","last_synced_at":"2026-02-05T19:03:09.261Z","repository":{"id":31850936,"uuid":"35418187","full_name":"AsamK/signal-cli","owner":"AsamK","description":"signal-cli provides an unofficial commandline, JSON-RPC and dbus interface for the Signal messenger.","archived":false,"fork":false,"pushed_at":"2024-10-28T22:38:16.000Z","size":5924,"stargazers_count":3200,"open_issues_count":51,"forks_count":302,"subscribers_count":62,"default_branch":"master","last_synced_at":"2024-10-29T14:59:09.882Z","etag":null,"topics":["commandline","dbus","java","json-rpc","messaging","signal","signal-cli"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AsamK.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":"FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"AsamK","liberapay":"asamk","ko_fi":"asamk"}},"created_at":"2015-05-11T10:49:42.000Z","updated_at":"2024-10-29T11:41:22.000Z","dependencies_parsed_at":"2023-02-19T10:30:44.821Z","dependency_job_id":"6d7573ee-f598-4f4e-9bda-56a908475bf8","html_url":"https://github.com/AsamK/signal-cli","commit_stats":{"total_commits":1812,"total_committers":63,"mean_commits":"28.761904761904763","dds":0.07615894039735094,"last_synced_commit":"9781c56571b063e90a50d66e2fcb5c7b3e11f08d"},"previous_names":[],"tags_count":93,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AsamK%2Fsignal-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AsamK%2Fsignal-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AsamK%2Fsignal-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AsamK%2Fsignal-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AsamK","download_url":"https://codeload.github.com/AsamK/signal-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247947803,"owners_count":21023066,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["commandline","dbus","java","json-rpc","messaging","signal","signal-cli"],"created_at":"2024-09-24T20:05:36.494Z","updated_at":"2026-02-05T19:03:09.255Z","avatar_url":"https://github.com/AsamK.png","language":"Java","readme":"# signal-cli\n\nsignal-cli is a commandline interface for the [Signal messenger](https://signal.org/).\nIt supports registering, verifying, sending and receiving messages.\nsignal-cli uses a [patched libsignal-service-java](https://github.com/Turasa/libsignal-service-java),\nextracted from the [Signal-Android source code](https://github.com/signalapp/Signal-Android/tree/main/libsignal-service).\nFor registering you need a phone number where you can receive SMS or incoming calls.\n\nsignal-cli is primarily intended to be used on servers to notify admins of important events.\nFor 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))\nand D-BUS interface ([man page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli-dbus.5.adoc)).\nFor the JSON-RPC interface there's also a simple [example client](https://github.com/AsamK/signal-cli/tree/master/client), written in Rust.\n\nsignal-cli needs to be kept up-to-date to keep up with Signal-Server changes.\nThe official Signal clients expire after three months and then the Signal-Server can make incompatible changes.\nSo signal-cli releases older than three months may not work correctly.\n\n## Installation\n\nYou can [build signal-cli](#building) yourself or use\nthe [provided binary files](https://github.com/AsamK/signal-cli/releases/latest), which should work on Linux, macOS and\nWindows. There's also a [docker image and some Linux packages](https://github.com/AsamK/signal-cli/wiki/Binary-distributions) provided by the community.\n\nSystem requirements:\n\n- at least Java Runtime Environment (JRE) 25\n- native library: libsignal-client\n\n  The native libs are bundled for x86_64 Linux (with recent enough glibc), Windows and MacOS. For other\n  systems/architectures\n  see: [Provide native lib for libsignal](https://github.com/AsamK/signal-cli/wiki/Provide-native-lib-for-libsignal)\n\n### Install system-wide on Linux [ JVM build ]\n\nSee [latest version](https://github.com/AsamK/signal-cli/releases).\n\n```sh\nVERSION=$(curl -Ls -o /dev/null -w %{url_effective} https://github.com/AsamK/signal-cli/releases/latest | sed -e 's/^.*\\/v//')\ncurl -L -O https://github.com/AsamK/signal-cli/releases/download/v\"${VERSION}\"/signal-cli-\"${VERSION}\".tar.gz\nsudo tar xf signal-cli-\"${VERSION}\".tar.gz -C /opt\nsudo ln -sf /opt/signal-cli-\"${VERSION}\"/bin/signal-cli /usr/local/bin/\n```\n\n### Install system-wide on Linux [ GraalVM native build ]\n\n```sh\nVERSION=$(curl -Ls -o /dev/null -w %{url_effective} https://github.com/AsamK/signal-cli/releases/latest | sed -e 's/^.*\\/v//')\ncurl -L -O https://github.com/AsamK/signal-cli/releases/download/v\"${VERSION}\"/signal-cli-\"${VERSION}\"-Linux-native.tar.gz\nsudo tar xf signal-cli-\"${VERSION}\"-Linux-native.tar.gz -C /opt\nsudo ln -sf /opt/signal-cli /usr/local/bin/\n```\n\nYou can find further instructions on the Wiki:\n\n- [Quickstart](https://github.com/AsamK/signal-cli/wiki/Quickstart)\n\n## Usage\n\nFor a complete usage overview please read\nthe [man page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli.1.adoc) and\nthe [wiki](https://github.com/AsamK/signal-cli/wiki).\n\nImportant: The ACCOUNT is your phone number in international format and must include the country calling code. Hence it\nshould start with a \"+\" sign. (See [Wikipedia](https://en.wikipedia.org/wiki/List_of_country_calling_codes) for a list\nof all country codes.)\n\n* Register a number (with SMS verification)\n\n      signal-cli -a ACCOUNT register\n\n  You can register Signal using a landline number. In this case, you need to follow the procedure below:\n   * Attempt a SMS verification process first (`signal-cli -a ACCOUNT register`)\n     * You will get an error `400 (InvalidTransportModeException)`, this is normal\n   * Wait 60 seconds\n   * Attempt a voice call verification by adding the `--voice` switch and wait for the call:\n\n     ```sh\n     signal-cli -a ACCOUNT register --voice\n     ```\n\n  Registering may require solving a CAPTCHA\n  challenge: [Registration with captcha](https://github.com/AsamK/signal-cli/wiki/Registration-with-captcha)\n\n* Verify the number using the code received via SMS or voice, optionally add `--pin PIN_CODE` if you've added a pin code\n  to your account\n\n      signal-cli -a ACCOUNT verify CODE\n\n* Send a message\n\n     ```sh\n     signal-cli -a ACCOUNT send -m \"This is a message\" RECIPIENT\n     ```\n\n* Send a message to a username, usernames need to be prefixed with `u:`\n\n     ```sh\n     signal-cli -a ACCOUNT send -m \"This is a message\" u:USERNAME.000\n     ```\n\n* Pipe the message content from another process.\n\n      uname -a | signal-cli -a ACCOUNT send --message-from-stdin RECIPIENT\n\n* Receive messages\n\n      signal-cli -a ACCOUNT receive\n\n**Hint**: The Signal protocol expects that incoming messages are regularly received (using `daemon` or `receive`\ncommand). This is required for the encryption to work efficiently and for getting updates to groups, expiration timer\nand other features.\n\n## Storage\n\nThe password and cryptographic keys are created when registering and stored in the current users home directory:\n\n    $XDG_DATA_HOME/signal-cli/data/\n    $HOME/.local/share/signal-cli/data/\n\n## Building\n\nThis project uses [Gradle](http://gradle.org) for building and maintaining dependencies. If you have a recent gradle\nversion installed, you can replace `./gradlew` with `gradle` in the following steps.\n\n1. Checkout the source somewhere on your filesystem with\n\n       git clone https://github.com/AsamK/signal-cli.git\n\n2. Execute Gradle:\n\n       ./gradlew build\n\n   2a. Create shell wrapper in *build/install/signal-cli/bin*:\n\n       ./gradlew installDist\n\n   2b. Create tar file in *build/distributions*:\n\n       ./gradlew distTar\n\n   2c. Create a fat tar file in *build/libs/signal-cli-fat*:\n\n       ./gradlew fatJar\n\n   2d. Compile and run signal-cli:\n\n      ```sh\n      ./gradlew run --args=\"--help\"\n      ```\n\n### Building a native binary with GraalVM (EXPERIMENTAL)\n\nIt is possible to build a native binary with [GraalVM](https://www.graalvm.org). This is still experimental and will not\nwork in all situations.\n\n1. [Install GraalVM and setup the environment](https://www.graalvm.org/docs/getting-started/#install-graalvm)\n2. Execute Gradle:\n\n       ./gradlew nativeCompile\n\n   The binary is available at *build/native/nativeCompile/signal-cli*\n\n## FAQ and Troubleshooting\n\nFor frequently asked questions and issues have a look at the [wiki](https://github.com/AsamK/signal-cli/wiki/FAQ).\n\n## License\n\nThis project uses libsignal-service-java from Open Whisper Systems:\n\nhttps://github.com/WhisperSystems/libsignal-service-java\n\nLicensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html\n","funding_links":["https://github.com/sponsors/AsamK","https://liberapay.com/asamk","https://ko-fi.com/asamk"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasamk%2Fsignal-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasamk%2Fsignal-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasamk%2Fsignal-cli/lists"}