![\"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/protocol\n\nShared TypeScript types and protocol contracts for Kraki.\n\n> Preview: `@kraki/protocol` may still evolve as Kraki's message model and clients expand.\n\nThis package contains the shared envelope, message, device, and auth types used across the relay, tentacle, and receiver apps.\n\n## Install\n\n```bash\nnpm i @kraki/protocol\n```\n\n## What it includes\n\n### Envelope types\n\n- **UnicastEnvelope** — sent from an app to a specific tentacle. Contains a `to` field identifying the target device and a `blob` with the encrypted payload.\n- **BroadcastEnvelope** — sent from a tentacle to all of a user's connected devices. Contains a `blob` and an optional `notify` hint.\n\n### Inner message types (inside encrypted blob)\n\n- **ProducerMessage** — messages from tentacle: session events, agent output, tool calls, permission requests.\n- **ConsumerMessage** — messages from arm: approvals, answers, follow-up input.\n\nThese types are only visible after decryption. The relay never sees them.\n\n### Control messages (unencrypted, relay-level)\n\n- **auth** — device authentication (discriminated union: `github_token`, `github_oauth`, `pairing`, `challenge`, `apikey`, `open`)\n- **device_joined** / **device_left** — presence notifications from the relay\n- **ping** / **pong** — heartbeat\n\n### Device and user models\n\n- device registration, identity, and public key types\n- user identity types\n\n## Example\n\n```ts\nimport type {\n UnicastEnvelope,\n BroadcastEnvelope,\n DeviceInfo,\n AuthMethod,\n} from '@kraki/protocol';\n```\n\nThis package is the schema layer only. It does not include a runtime client or server.\n\n## Links\n\n- Main docs: `https://github.com/corelli18512/kraki/blob/main/README.md`\n- Architecture: `https://github.com/corelli18512/kraki/blob/main/ARCHITECTURE.md`\n","readmeFilename":"README.md"}