|
1 | | -# KafClaw Documentation |
| 1 | +--- |
| 2 | +title: Home |
| 3 | +nav_order: 1 |
| 4 | +--- |
2 | 5 |
|
3 | | -<p align="center"> |
4 | | - <img src="./assets/kafclaw.png" alt="KafClaw Logo" width="320" /> |
5 | | -</p> |
| 6 | +# KafClaw Documentation (v2) |
6 | 7 |
|
7 | | -KafClaw is a Go-based agent runtime with three practical deployment modes: |
8 | | - |
9 | | -- `local`: personal assistant on one machine |
10 | | -- `local-kafka`: local runtime connected to Kafka/group orchestration |
11 | | -- `remote`: headless gateway reachable over network (token required) |
12 | | - |
13 | | -## Ecosystem |
14 | | - |
15 | | -- **KafScale** ([github.com/kafscale](https://github.com/kafscale), [kafscale.io](https://kafscale.io)): Kafka-compatible and S3-compatible data plane used for durable event transport and large artifact flows in agent systems. |
16 | | -- **GitClaw** (in this KafClaw repository): agentic, self-hosted GitHub replacement focused on autonomous repository workflows and automation. |
17 | | -- **KafClaw**: runtime and coordination layer for local, Kafka-connected, and remote/headless agents. |
18 | | - |
19 | | -## Why KafClaw |
20 | | - |
21 | | -KafClaw gives teams an enterprise-ready way to run and coordinate autonomous agents over Apache Kafka. |
22 | | -Instead of locking agents to one model, one language, or one SDK, it uses a typed Kafka message protocol so any runtime that can read and write JSON envelopes can participate. |
23 | | - |
24 | | -What this enables in practice: |
25 | | - |
26 | | -- Reliable multi-agent collaboration with correlation IDs, timestamps, and trace-friendly envelopes |
27 | | -- Group and hierarchy orchestration with role boundaries and scoped visibility |
28 | | -- Shared memory and skill routing so agents can reuse knowledge across sessions |
29 | | -- Flexible deployment from a single local assistant to a Kafka-connected production gateway |
30 | | - |
31 | | -In short: Kafka is the backbone, and KafClaw is the coordination layer that keeps heterogeneous agents working together safely and observably. |
| 8 | +This documentation site is organized around the **v2** reference set. |
32 | 9 |
|
33 | 10 | ## Start Here |
34 | 11 |
|
35 | | -- [Getting Started](./getting-started.md) - install, onboard, first run |
36 | | -- [Manage KafClaw](./manage-kafclaw.md) - operator runbook for CLI, health checks, group and bridge operations |
37 | | -- [Operations and Maintenance](./maintenance.md) - runbook for updates, checks, backups, troubleshooting |
38 | | -- [Architecture Visual (HTML)](./architecture.html) - system overview diagram and component map |
39 | | - |
40 | | -## Agent Concepts |
41 | | - |
42 | | -- [How Agents Work](./concepts/how-agents-work.md) - end-to-end runtime flow from inbound message to outbound response |
43 | | -- [Soul and Identity Files](./concepts/soul-identity-tools.md) - what `AGENTS.md`, `SOUL.md`, `USER.md`, `TOOLS.md`, `IDENTITY.md` do |
44 | | -- [Runtime Tools and Capabilities](./concepts/runtime-tools.md) - actual tools registered by the Go runtime |
45 | | - |
46 | | -## Integrations |
47 | | - |
48 | | -- [Slack and Teams Bridge](./v2/slack-teams-bridge.md) |
49 | | -- [WhatsApp Setup](./v2/whatsapp-setup.md) |
50 | | -- [WhatsApp Onboarding](./v2/whatsapp-onboarding.md) |
51 | | - |
52 | | -## Operations and Admin |
53 | | - |
| 12 | +- [v2 Docs Index](./v2/index.md) |
| 13 | +- [User Manual](./v2/user-manual.md) |
54 | 14 | - [Admin Guide](./v2/admin-guide.md) |
55 | 15 | - [Operations Guide](./v2/operations-guide.md) |
56 | | -- [Docker Deployment](./v2/docker-deployment.md) |
57 | | -- [Release Guide](./v2/release.md) |
58 | 16 |
|
59 | | -## Architecture and Security |
| 17 | +## Architecture |
60 | 18 |
|
61 | 19 | - [Architecture Overview](./v2/architecture.md) |
62 | 20 | - [Detailed Architecture](./v2/architecture-detailed.md) |
63 | 21 | - [Timeline Architecture](./v2/architecture-timeline.md) |
64 | | -- [Security Risks](./v2/security-risks.md) |
65 | | -- [Subagents Threat Model](./v2/subagents-threat-model.md) |
66 | | - |
67 | | -## Full v2 Reference Set |
68 | | - |
69 | | -- [v2 Index](./v2/index.md) |
70 | | -- [User Manual](./v2/user-manual.md) |
71 | 22 |
|
72 | | -## Security Baseline |
| 23 | +## Security and Risk |
73 | 24 |
|
74 | | -- Default bind is loopback: `127.0.0.1` |
75 | | -- Remote/headless mode should use auth token for dashboard API |
76 | | -- When `gateway.authToken` is set, both dashboard API and `POST /chat` require bearer auth (dashboard keeps `/api/v1/status` open for health checks) |
77 | | -- Use `kafclaw doctor` for diagnostics |
78 | | -- Use `kafclaw doctor --fix` for env merge and permissions hygiene |
| 25 | +- [Security Risks](./v2/security-risks.md) |
| 26 | +- [Subagents Threat Model](./v2/subagents-threat-model.md) |
79 | 27 |
|
80 | | -## Repository Docs Areas |
| 28 | +## Integrations and Deployment |
81 | 29 |
|
82 | | -- `docs/concepts/` - runtime behavior and core mental models |
83 | | -- `docs/v2/` - full product and operations reference set |
84 | | -- `docs/security/` - security audits and roadmap |
| 30 | +- [Slack and Teams Bridge](./v2/slack-teams-bridge.md) |
| 31 | +- [WhatsApp Setup](./v2/whatsapp-setup.md) |
| 32 | +- [WhatsApp Onboarding](./v2/whatsapp-onboarding.md) |
| 33 | +- [Docker Deployment](./v2/docker-deployment.md) |
| 34 | +- [Release Guide](./v2/release.md) |
0 commit comments