Skip to content

Commit 0857bb3

Browse files
committed
docs: update READEME
1 parent 46a870d commit 0857bb3

File tree

2 files changed

+74
-64
lines changed

2 files changed

+74
-64
lines changed

README.md

Lines changed: 73 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -25,73 +25,14 @@ see [UniAST Specification](docs/uniast-zh.md)
2525

2626

2727
# Quick Start
28-
## Use ABCoder as a MCP server
29-
30-
1. Install ABCoder:
31-
32-
```bash
33-
go install github.com/cloudwego/abcoder@latest
34-
```
35-
36-
2. Use ABCoder to parse a repository to UniAST (JSON)
37-
38-
```bash
39-
abcoder parse {language} {repo-path} -o xxx.json
40-
```
41-
42-
ABCoder will try to install any dependency automatically.
43-
In case of failure (or if you want to customize installation), refer to the [docs](./docs/lsp-installation-en.md).
44-
45-
For example, to parse a Go repository:
46-
47-
```bash
48-
git clone https://github.com/cloudwego/localsession.git localsession
49-
abcoder parse go localsession -o /abcoder-asts/localsession.json
50-
```
51-
52-
53-
3. Integrate ABCoder's MCP tools into your AI agent.
54-
55-
```json
56-
{
57-
"mcpServers": {
58-
"abcoder": {
59-
"command": "abcoder",
60-
"args": [
61-
"mcp",
62-
"{the-AST-directory}"
63-
]
64-
}
65-
}
66-
}
67-
```
68-
69-
70-
4. Enjoy it!
71-
72-
Try to click and watch the video below:
73-
74-
<div align="center">
75-
76-
[<img src="images/abcoder-hertz-trae.png" alt="MCP" width="500"/>](https://www.bilibili.com/video/BV14ggJzCEnK)
77-
78-
</div>
79-
80-
81-
## Tips:
82-
83-
- You can add more repo ASTs into the AST directory without restarting abcoder MCP server.
84-
85-
- Try to use [the recommended prompt](llm/prompt/analyzer.md) and combine planning/memory tools like [sequential-thinking](https://github.com/modelcontextprotocol/servers/tree/main/src/sequentialthinking) in your AI agent.
86-
8728

8829
## Claude Code Integration
8930

9031
ABCoder provides deep integration with [Claude Code](https://claude.ai/code) through the AST-Driven Coding workflow, enabling hallucination-free code analysis and precise execution. Check [Claude Code Specification](docs/claude-code-spec.md) for more details.
9132

9233
### Setup
9334

94-
Use the `init-spec` command to automatically configure Claude Code integration:
35+
Use the `init-spec` command to automatically configure Claude Code integration for your project:
9536

9637
```bash
9738
# Install ABCoder
@@ -109,6 +50,16 @@ The `init-spec` command will:
10950
- `sequential-thinking`: for complex problem decomposition
11051
3. Replace all `{{CLAUDE_HOME_PATH}}` placeholders with actual project paths
11152

53+
### Start Coding with Claude Code
54+
55+
Once setup, you can start coding with Claude Code:
56+
57+
1. Start Claude Code in your project directory
58+
2. Use slash common `/abcoder:schedule <problem_desc>` to address your feature/requirement/issue, and ABCoder will help you analyze the codebase and design a technical solution.
59+
3. Once all questions are set, use slash common `/abcoder:task <task_name>` to create a coding task(specification)
60+
4. Recheck the task using `/abcoder:recheck <task_name>` before real implementation
61+
5. Begin coding! Claude Code will process the task step by step according to the specification, leveraging the power of AST-driven analysis.
62+
11263
### AST-Driven Coding Workflow
11364

11465
[`.claude/hooks`](docs/.claude/hooks) provide a 4-layer analysis chain from repository to node details:
@@ -125,7 +76,7 @@ list_repos → get_repo_structure → get_package_structure → get_file_structu
12576

12677
| Command | Function | Description |
12778
|---------|----------|-------------|
128-
| [`/abcoder:schedule` <task_desc>](docs/.claude/commands/abcoder:schedule.md) | Design implementation | Analyze codebase using ABCoder, design technical solution |
79+
| [`/abcoder:schedule` <task_desc>](docs/.claude/commands/abcoder:schedule.md) | Design implementation | Analyze codebase by using ABCoder, design technical solution |
12980
| [`/abcoder:task <name>`](docs/.claude/commands/abcoder:task.md) | Create coding task | Generate standardized CODE_TASK document |
13081
| [`/abcoder:recheck <task>`](docs/.claude/commands/abcoder:recheck.md) | Verify solution | Critically check CODE_TASK feasibility, useful when a CODE_TASK contains external dependencies |
13182

@@ -160,13 +111,72 @@ Start coding(sub-agent) ─────────→ Execute Implementation
160111
### Dependencies
161112

162113
- Claude Code CLI
163-
- abcoder MCP server (provides `mcp__abcoder` tools)
164-
- sequential-thinking MCP server (provides `mcp__sequential_thinking` tools, automatically configured by init-spec)
114+
- ABCoder MCP server (provides `mcp__abcoder` tools)
115+
- Sequential-thinking MCP server (provides `mcp__sequential_thinking` tools, automatically configured by init-spec)
165116

166117
> For detailed configuration, see [docs/.claude/README.md](docs/.claude/README.md)
167118
168119
> Watch the demo video [here](https://github.com/cloudwego/abcoder/pull/141)
169120
121+
## Use ABCoder as a MCP server
122+
123+
1. Install ABCoder:
124+
125+
```bash
126+
go install github.com/cloudwego/abcoder@latest
127+
```
128+
129+
2. Use ABCoder to parse a repository to UniAST (JSON)
130+
131+
```bash
132+
abcoder parse {language} {repo-path} -o xxx.json
133+
```
134+
135+
ABCoder will try to install any dependency automatically.
136+
In case of failure (or if you want to customize installation), refer to the [docs](./docs/lsp-installation-en.md).
137+
138+
For example, to parse a Go repository:
139+
140+
```bash
141+
git clone https://github.com/cloudwego/localsession.git localsession
142+
abcoder parse go localsession -o /abcoder-asts/localsession.json
143+
```
144+
145+
146+
3. Integrate ABCoder's MCP tools into your AI agent.
147+
148+
```json
149+
{
150+
"mcpServers": {
151+
"abcoder": {
152+
"command": "abcoder",
153+
"args": [
154+
"mcp",
155+
"{the-AST-directory}"
156+
]
157+
}
158+
}
159+
}
160+
```
161+
162+
163+
4. Enjoy it!
164+
165+
Try to click and watch the video below:
166+
167+
<div align="center">
168+
169+
[<img src="images/abcoder-hertz-trae.png" alt="MCP" width="500"/>](https://www.bilibili.com/video/BV14ggJzCEnK)
170+
171+
</div>
172+
173+
174+
## Tips:
175+
176+
- You can add more repo ASTs into the AST directory without restarting abcoder MCP server.
177+
178+
- Try to use [the recommended prompt](llm/prompt/analyzer.md) and combine planning/memory tools like [sequential-thinking](https://github.com/modelcontextprotocol/servers/tree/main/src/sequentialthinking) in your AI agent.
179+
170180
171181
## Use ABCoder as an Agent (WIP)
172182

internal/utils/cmd_init_spec.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2025 ByteDance Inc.
2+
* Copyright 2026 ByteDance Inc.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)