Skip to content

Commit 03b6422

Browse files
committed
pre-launch polish: fix CONFIG.md corruption, add LICENSE, README fixes
- CONFIG.md: stripped embedded line number prefixes from file content (was: ' 124|some text' — now: 'some text') - LICENSE: added MIT license file (was referenced but missing) - README: fixed Skill System leading pipe character (table rendering bug) - README: updated test count to 695+ (was stale 220+) - README: changed MCP emoji from 🔌 (conflict with LLM-Agnostic) to 🔗 - README: added kode mcp to commands cheatsheet - README: mentioned OPENAI_API_KEY fallback in install example - Removed stale build artifacts (bin/kode, kode, coverage.out)
1 parent 1932f38 commit 03b6422

3 files changed

Lines changed: 233 additions & 212 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 BackendStack21
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ One binary. One loop. Zero frameworks. ReAct (Reasoning + Acting) — think, the
88
# Install
99
go install github.com/BackendStack21/kode/cmd/kode@latest
1010

11-
# Use
11+
# Use (set DEEPSEEK_API_KEY or OPENAI_API_KEY)
1212
export DEEPSEEK_API_KEY=sk-...
1313
kode run "How many lines in go.mod?"
1414
# → 3 lines
@@ -39,7 +39,7 @@ kode is not a framework. It's a **runtime** — the smallest possible surface ar
3939
Parallel OS-process sub-agents via `delegate_tasks`. True isolation — each sub-agent is a fresh `kode subagent` process with its own config, tools, and termination timeout. Up to 8 concurrent workers. [docs/SUBAGENTS.md](docs/SUBAGENTS.md)
4040

4141
### 🧠 Skill System (on by default)
42-
|Trigger-matched `SKILL.md` files load on-demand. Auto-learns from patterns every session — detects multi-step procedures, error recoveries, repeated actions, and user corrections. **LLM-enhanced**: each detected pattern is enriched with an LLM-generated name, description, trigger keywords, and structured body with overview, steps, pitfalls, and verification sections. Use `--no-learn` to disable. Import skills from any URI with automatic LLM risk assessment. [docs/CLI.md#skills](docs/CLI.md#skills)
42+
Skill-matched `SKILL.md` files load on-demand. Auto-learns from patterns every session — detects multi-step procedures, error recoveries, repeated actions, and user corrections. **LLM-enhanced**: each detected pattern is enriched with an LLM-generated name, description, trigger keywords, and structured body with overview, steps, pitfalls, and verification sections. Use `--no-learn` to disable. Import skills from any URI with automatic LLM risk assessment. [docs/CLI.md#skills](docs/CLI.md#skills)
4343

4444
### 💾 Persistent Memory
4545
Three tiers: **facts** (agent-managed durable entries), **session buffer** (auto-appended turn summaries), **episodes** (LLM-extracted knowledge from past sessions). Merge-on-write via go-vector RandomProjections — cosine >0.7 auto-merges, <0.3 auto-adds. Saves ~80% LLM calls. [docs/MEMORY.md](docs/MEMORY.md)
@@ -56,7 +56,7 @@ Any OpenAI-compatible endpoint: Deepseek, OpenAI, Anthropic, Ollama, vLLM, Groq,
5656
### 🌐 Web UI
5757
`kode serve` — browser-based agent with `@` resource completion (`@file.go`, `@sess:abc123`), WebSocket streaming, and a full IDE-style console. [docs/WEBUI.md](docs/WEBUI.md)
5858

59-
### 🔌 MCP (Two-Way)
59+
### 🔗 MCP (Two-Way)
6060
**Server** (`kode mcp`) — expose kode's native tools (shell, read/write/search files, patch, browser) to Claude Code, Cursor, and any MCP client. **Client** (`mcp_servers` config) — kode connects to external MCP servers (Playwright, Fetch, GitHub, SQLite, etc.) and makes their tools available to the agent as `<server>__<tool>`. Both directions in one binary. [docs/MCP.md](docs/MCP.md)
6161

6262
### 🔍 Native Tools
@@ -112,6 +112,7 @@ kode repl
112112
| `kode serve [--addr :8080]` | Start Web UI server |
113113
| `kode subagent --goal <string>` | Run a focused sub-task |
114114
| `kode init [--global]` | Create config file |
115+
| `kode mcp [--sandbox]` | Start MCP server — expose tools to Claude Code |
115116
| `kode version` | Print version |
116117

117118
### Key Flags
@@ -172,9 +173,9 @@ The full `Config` struct supports: `BaseURL`, `Thinking`, `SandboxCleanup`, `Ren
172173
## Test
173174

174175
```bash
175-
go test ./... # 220+ tests, all pass
176+
go test ./... # 695+ tests, all pass
176177
go test -race ./... # race detector clean
177-
go test -cover ./... # 80%+ coverage
178+
go test -cover ./... # 80%+ average coverage
178179
```
179180

180181
Everything runs with `go test` — no Docker, no network, no external services required for unit tests.

0 commit comments

Comments
 (0)