{"id":15027007,"url":"https://github.com/asamk/signal-cli","last_synced_at":"2026-06-11T13:00:34.096Z","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":"2026-06-11T10:53:55.000Z","size":6981,"stargazers_count":4670,"open_issues_count":95,"forks_count":418,"subscribers_count":63,"default_branch":"master","last_synced_at":"2026-06-11T12:21:37.615Z","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"AsamK","liberapay":"asamk","ko_fi":"asamk"}},"created_at":"2015-05-11T10:49:42.000Z","updated_at":"2026-06-11T12:04:35.000Z","dependencies_parsed_at":"2026-03-03T01:07:58.059Z","dependency_job_id":"d8cea24f-ffec-4f67-9dbe-816dd696bb8f","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":115,"template":false,"template_full_name":null,"purl":"pkg:github/AsamK/signal-cli","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","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AsamK%2Fsignal-cli/sbom","scorecard":{"id":16832,"data":{"date":"2025-08-11","repo":{"name":"github.com/AsamK/signal-cli","commit":"f9a36c6e0404d06bd396b24b5ea699e49ed29b89"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.7,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":10,"reason":"30 commit(s) and 16 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: jobLevel 'contents' permission set to 'write': .github/workflows/release.yml:21","Warn: jobLevel 'contents' permission set to 'write': .github/workflows/release.yml:29","Info: jobLevel 'contents' permission set to 'read': .github/workflows/release.yml:165","Warn: jobLevel 'packages' permission set to 'write': .github/workflows/release.yml:166","Info: jobLevel 'contents' permission set to 'read': .github/workflows/release.yml:215","Warn: jobLevel 'packages' permission set to 'write': .github/workflows/release.yml:216","Warn: topLevel 'contents' permission set to 'write': .github/workflows/ci.yml:11","Info: topLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:13","Warn: topLevel 'security-events' permission set to 'write': .github/workflows/codeql-analysis.yml:14","Warn: topLevel 'contents' permission set to 'write': .github/workflows/release.yml:9"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"SAST","score":10,"reason":"SAST tool detected: CodeQL","details":["Info: SAST configuration detected: CodeQL","Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: gradle/wrapper/gradle-wrapper.jar:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:91: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/codeql-analysis.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:103: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:112: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:132: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:169: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:171: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:189: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:198: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:219: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:221: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:237: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:246: update your workflow using https://app.stepsecurity.io/secureworkflow/AsamK/signal-cli/release.yml/master?enable=pin","Info:   0 out of  20 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   7 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":8,"reason":"5 out of the last 5 releases have a total of 5 signed artifacts.","details":["Info: signed release artifact: signal-cli-0.13.18-Linux-native.tar.gz.asc: https://github.com/AsamK/signal-cli/releases/tag/v0.13.18","Info: signed release artifact: signal-cli-0.13.17-Linux-native.tar.gz.asc: https://github.com/AsamK/signal-cli/releases/tag/v0.13.17","Info: signed release artifact: signal-cli-0.13.16-Linux-native.tar.gz.asc: https://github.com/AsamK/signal-cli/releases/tag/v0.13.16","Info: signed release artifact: signal-cli-0.13.15-Linux-native.tar.gz.asc: https://github.com/AsamK/signal-cli/releases/tag/v0.13.15","Info: signed release artifact: signal-cli-0.13.14.tar.gz.asc: https://github.com/AsamK/signal-cli/releases/tag/v0.13.14","Warn: release artifact v0.13.18 does not have provenance: https://api.github.com/repos/AsamK/signal-cli/releases/232935432","Warn: release artifact v0.13.17 does not have provenance: https://api.github.com/repos/AsamK/signal-cli/releases/228533156","Warn: release artifact v0.13.16 does not have provenance: https://api.github.com/repos/AsamK/signal-cli/releases/223800188","Warn: release artifact v0.13.15 does not have provenance: https://api.github.com/repos/AsamK/signal-cli/releases/217438934","Warn: release artifact v0.13.14 does not have provenance: https://api.github.com/repos/AsamK/signal-cli/releases/210617992"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-14T15:58:26.110Z","repository_id":31850936,"created_at":"2025-08-14T15:58:26.110Z","updated_at":"2025-08-14T15:58:26.110Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34199516,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-11T02:00:06.485Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-06-11T13:00:34.090Z","avatar_url":"https://github.com/AsamK.png","language":"Java","funding_links":["https://github.com/sponsors/AsamK","https://liberapay.com/asamk","https://ko-fi.com/asamk"],"categories":[],"sub_categories":[],"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### JSON Schemas for the JSON-RPC mode\n\n1. Generate [JSON Schema](https://json-schema.org/) files for all the JSON-RPC data classes (`src/main/java/org/asamk/signal/json`):\n\n    ```sh\n    ./gradlew jsonSchemas\n    ```\n\n2. The generated files can be found in the `build/generated/META-INF/schemas` folder.\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","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"}