You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Identity Repository** — Contains the soul files loaded at startup into the LLM system prompt:
52
52
@@ -58,7 +58,7 @@ KafClaw organizes state across three logical repositories:
58
58
|`TOOLS.md`| Tool reference with signatures and safety notes |
59
59
|`USER.md`| User profile (name, timezone, preferences, work context) |
60
60
61
-
Soul files are scaffolded by `gomikrobot onboard` from embedded templates (`internal/identity/templates/`). Users can then customize them freely. The canonical file list is defined once in `identity.TemplateNames`.
61
+
Soul files are scaffolded by `kafclaw onboard` from embedded templates (`internal/identity/templates/`). Users can then customize them freely. The canonical file list is defined once in `identity.TemplateNames`.
62
62
63
63
**Work Repository** — Git-initialized sandbox with standard directories: `requirements/`, `tasks/`, `docs/`, `memory/`. The agent's `write_file` tool targets this repo by default.
64
64
@@ -69,8 +69,8 @@ Soul files are scaffolded by `gomikrobot onboard` from embedded templates (`inte
69
69
## 2. Directory Structure
70
70
71
71
```
72
-
gomikrobot/
73
-
├── cmd/gomikrobot/cmd/ # CLI commands (Cobra)
72
+
kafclaw/
73
+
├── cmd/kafclaw/cmd/ # CLI commands (Cobra)
74
74
│ ├── root.go # Root command, version (v2.5.3)
75
75
│ ├── gateway.go # Main daemon (~2800 lines, all API endpoints)
76
76
│ ├── agent.go # Single-message CLI mode
@@ -124,8 +124,8 @@ gomikrobot/
124
124
The gateway command (`runGateway`) initializes all subsystems in a specific dependency order:
Copy file name to clipboardExpand all lines: CLAUDE.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,24 +4,24 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
4
4
5
5
## Project Overview
6
6
7
-
KafClaw (formerly GoMikroBot) is a personal AI assistant written in Go. The Go source lives in `gomikrobot/`. Sensitive specs, tasks, research, and governance docs live in the `private/` directory (gitignored — tracked separately).
7
+
KafClaw (formerly KafClaw) is a personal AI assistant written in Go. The Go source lives in `kafclaw/`. Sensitive specs, tasks, research, and governance docs live in the `private/` directory (gitignored — tracked separately).
8
8
9
9
## Build & Run
10
10
11
-
All Go commands run from the `gomikrobot/` directory:
11
+
All Go commands run from the `kafclaw/` directory:
12
12
13
13
```bash
14
-
cdgomikrobot
14
+
cdKafClaw
15
15
16
16
# Build
17
-
make build # or: go build ./cmd/gomikrobot
17
+
make build # or: go build ./cmd/kafclaw
18
18
19
19
# Run gateway (multi-channel daemon)
20
20
make run # build + run
21
21
make rerun # kill existing ports 18790/18791, rebuild, run
22
22
23
23
# Run single message
24
-
./gomikrobot agent -m "hello"
24
+
./kafclaw agent -m "hello"
25
25
26
26
# Run tests
27
27
go test ./... # all tests
@@ -42,8 +42,8 @@ make release-patch # or release-minor, release-major
42
42
KafClaw/
43
43
├── CLAUDE.md ← this file
44
44
├── .github/workflows/ ← CI/CD (release.yml)
45
-
├── gomikrobot/ ← Go source code
46
-
│ ├── cmd/gomikrobot/ ← CLI entry point (cobra commands)
45
+
├── kafclaw/ ← Go source code
46
+
│ ├── cmd/kafclaw/ ← CLI entry point (cobra commands)
KafClaw organizes state across three logical repositories:
77
77
78
-
-**Identity (Workspace)** — Soul files (IDENTITY.md, SOUL.md, AGENTS.md, TOOLS.md, USER.md) loaded at startup into the LLM system prompt. Scaffolded by `gomikrobot onboard`, user-customizable.
78
+
-**Identity (Workspace)** — Soul files (IDENTITY.md, SOUL.md, AGENTS.md, TOOLS.md, USER.md) loaded at startup into the LLM system prompt. Scaffolded by `kafclaw onboard`, user-customizable.
-**System Repo** — Bot source code (this repo). Read-only at runtime. Contains skills and operational guidance.
81
81
82
82
The canonical soul file list is `identity.TemplateNames` in `internal/identity/embed.go` — single source of truth used by both `agent/context.go` and `memory/indexer.go`.
83
83
84
84
## Workspace Scaffolding
85
85
86
-
Running `gomikrobot onboard` creates `~/.gomikrobot/config.json`**and** scaffolds soul files into the workspace:
86
+
Running `kafclaw onboard` creates `~/.kafclaw/config.json`**and** scaffolds soul files into the workspace:
**New channel:** Implement `Channel` interface in `internal/channels/`, subscribe to the message bus, add config fields to `internal/config/config.go`.
137
137
138
-
**New CLI command:** Create file in `cmd/gomikrobot/cmd/`, define cobra command, register in `root.go` init().
138
+
**New CLI command:** Create file in `cmd/kafclaw/cmd/`, define cobra command, register in `root.go` init().
139
139
140
140
## Task Workflow
141
141
@@ -160,4 +160,4 @@ Bug reports and task logs are **public** — they go in the code repo under `doc
160
160
161
161
## Go Module
162
162
163
-
The Go module path is `github.com/KafClaw/KafClaw/gomikrobot`.
163
+
The Go module path is `github.com/KafClaw/KafClaw`.
0 commit comments