# Clankie

> A persistent agent with a life of his own. Clankie runs on your machine, an Apple-silicon Mac: he chats in Discord (text and voice), plays Pokémon live on a watch surface, makes images and videos, browses the web, remembers people, codes, and leads a fleet of coding agents through herdr panes. Your machine is authoritative; nothing of his runs in the cloud. An iPhone and iPad app reaches your machine through a narrow public gateway (`api.clankie.bot`) and does not require Tailscale.

He is one local service (`apps/clankie`, HTTP on `127.0.0.1:4310`) plus the surfaces that reach it: the operator console (TUI), the companion app, one active Discord body, a Claude Code seat, and a macOS menu bar. The captain is a pi-based agent with durable sessions per room; persona is owner-authored; model output and Discord content are untrusted input. `clankie <noun> <verb>` is the headless control layer and prints one JSON document per command.

## Docs

- [Start](https://docs.clankie.bot/): Install Clankie on your machine, give him a model, reach him from your phone.
- [How he works](https://docs.clankie.bot/how-it-works/): One service on your machine, the rooms he lives in, how a message becomes a turn, and what stays where.
- [Console](https://docs.clankie.bot/console/): Every slash command and key in the operator console, generated from the console's own registry.
- [CLI](https://docs.clankie.bot/cli/): The headless clankie command contract: flags, JSON on stdout, exit codes.
- [HTTP API](https://docs.clankie.bot/api/): The local service catalog on 127.0.0.1:4310, generated from the OpenAPI document.
- [Network](https://docs.clankie.bot/network/): The exact public routes at api.clankie.bot and the authorization each one requires.
- [OpenAPI document](https://docs.clankie.bot/api/openapi.yaml): the raw local service catalog
- [Everything on one page](https://docs.clankie.bot/llms-full.txt): the pages above plus the repository architecture document, as Markdown

## Source

- [Repository](https://github.com/Volpestyle/clankie): Apache-2.0, except the AGPL native Discord media process
- [Architecture](https://github.com/Volpestyle/clankie/blob/main/docs/architecture.md): the system shape and where things run
- [Decision records](https://github.com/Volpestyle/clankie/blob/main/docs/adr): why each boundary is where it is
- [Agent instructions](https://github.com/Volpestyle/clankie/blob/main/AGENTS.md): read before pointing a coding agent at the repository

## Product

- [Home](https://clankie.bot)
- [Privacy](https://clankie.bot/privacy/)
- [Support](https://clankie.bot/support/)