This documentation is organized around the lifecycle of a Signal SDK integration.
- Installation & Setup — install the SDK, signal-cli v0.14.10, and the required Java runtime.
- Device Linking — link a Signal account before sending or receiving messages.
- Getting Started — create a client and send a first message.
- Examples Guide — run the included SDK and bot examples.
- API Reference — public classes, methods, options, events, and types.
- Advanced Features — messaging, accounts, groups, polls, and daemon modes.
- SignalBot Framework — commands, permissions, lifecycle, and middleware.
- Robust Infrastructure — validation, retrying, rate limiting, logging, and configuration.
- Troubleshooting — common installation and runtime failures.
- FAQ — concise answers to frequently asked questions.
SDK v0.2.9 is aligned with signal-cli v0.14.10. On macOS and Windows, the bundled JVM distribution requires Java 25 or later. Linux uses the native signal-cli binary installed by the package post-install script.
Documentation describes the published API and intentionally avoids historical test counts and implementation-phase labels. Before a release, verify the examples, API reference, changelog, and installation requirements against the current package version.