clankie
docsReference
Choose the reference for the job. Get started covers setup; using Clankie explains the everyday experience; Customize Clankie introduces the optional technical depth.
Operate Clankie
| I want to… | Read |
|---|---|
| Find a console command or keyboard shortcut | Console |
| Script configuration, inspect status, or troubleshoot | CLI |
| Install a pinned release or understand its files | Distribution |
| Understand credentials and access | Credentials |
| Inspect what he remembers | Memory |
| Configure Discord voice, music, or a watch surface | Discord media |
| Connect coding agents and other machines | Native agent adapters and runtime connections |
| Grant a worker limited use of a connected account | Worker access |
| Run the service on Linux | Self-hosted Linux |
Integrate and contribute
| Reference | Owns |
|---|---|
| How he works | A readable overview of the service and its connections |
| Architecture | Current system boundaries and request flows |
| HTTP API | The service's route catalog, rendered from OpenAPI |
| Public network | The gateway's allowed host routes and their authorization |
| Library index | Subsystem references, design proposals, and evidence |
| Contributing | Source setup, checks, and repository boundaries |
The CLI reference is rendered from its canonical Markdown. The console command table, HTTP catalog, and public host-route table are generated from their source registries. Generation keeps the catalogs aligned; implementation and release availability still need their own verification.
History and machine-readable docs
Decision records explain why boundaries changed. They include superseded designs; use the current references above for setup. Dated verification records say what was tested on a particular revision and environment.
llms.txt indexes these docs for agents. llms-full.txt contains the public guides, references, and repository architecture in one Markdown document.