![\"Kraki\"](\"https://raw.githubusercontent.com/corelli18512/kraki/main/logo.png\"){kind=logo}
\n \n\n \n \n \n
\n GitHub repository\n
\n\n# Kraki\n\nCLI bridge that connects your coding machine to Kraki.\n\n> Preview: Kraki is still early-stage. Expect breaking changes while the core flows stabilize.\n\nKraki runs next to your coding agent, connects to a relay, and lets you watch and steer sessions from your phone or another device.\n\nRight now the main supported agent flow is GitHub Copilot CLI.\n\n## Install\n\n```bash\n# macOS / Linux\ncurl -fsSL https://app.kraki.chat/install.sh | bash\n\n# Windows (PowerShell)\nirm https://app.kraki.chat/install.ps1 | iex\n\n# or with npm (all platforms)\nnpm i -g @kraki/tentacle\nkraki\n```\n\nOr [download the binary manually](https://github.com/corelli18512/kraki/releases/latest).\n\n## Requirements\n\n- GitHub Copilot CLI installed on the coding machine\n- A browser or phone to connect to the Kraki web app\n\n## Quick start\n\n1. Download and run the binary\n2. Follow the setup prompts in the terminal\n3. By default it connects to the hosted relay\n4. Scan the QR code or open the web app to connect your browser or phone\n\nThe hosted web app lives at:\n\n- `https://app.kraki.chat`\n\n## What tentacle handles\n\nBeyond bridging agent events, tentacle is responsible for several things that used to live on the relay:\n\n- **Sequence numbers and timestamps** — assigned locally by tentacle, not by the relay\n- **Message buffering** — tentacle buffers messages and handles replay when devices reconnect\n- **Session lifecycle** — session create, update, and close are managed here\n- **Auto-approval** — tools on a local allowed list are approved automatically without user interaction\n- **Encryption** — all outgoing messages are encrypted before leaving the machine\n- **Attachment storage** — image bytes produced by the agent are stored content-addressed on disk and streamed to receivers in chunks, not embedded inline in messages\n- **Kraki MCP server** — a loopback HTTP server exposing tools the agent can call to surface images (`kraki-show_image`) and similar artifacts to user-facing devices\n\nThe relay is a thin forwarder. Tentacle and the frontend own the application logic.\n\n## Useful commands\n\n```bash\nkraki # start the tentacle / setup flow\nkraki status # show daemon + relay status\nkraki connect # generate a fresh QR code / pairing link\nkraki stop # stop the local daemon\n```\n\n## Use your own relay\n\nStart a relay with `@kraki/head`:\n\n```bash\nnpx @kraki/head\n\n# or\nnpm i -g @kraki/head\nkraki-relay\n```\n\nThen point tentacle setup at your own relay URL instead of the hosted default.\n\n## Links\n\n- Main docs: `https://github.com/corelli18512/kraki/blob/main/README.md`\n- Security model: `https://github.com/corelli18512/kraki/blob/main/SECURITY.md`\n","readmeFilename":"README.md"}