Skip to content

Commit c488ba4

Browse files
committed
docs(mpp): add new guides for MPP, CLI TUI, and remote usage
Added documentation for Android, Desktop, CLI TUI, remote usage, and a quickstart guide. Updated the MPP index to reference new content.
1 parent f9a8a26 commit c488ba4

File tree

6 files changed

+136
-2
lines changed

6 files changed

+136
-2
lines changed

docs/mpp/autodev-cli-tui.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: AutoDev CLI/TUI
3+
slug: autodev-cli-tui
4+
nav_order: 3
5+
parent: AutoDev MPP
6+
---
7+
8+
AutoDev CLI 在设计和 Tool 的实现上参考了 Gemini CLI,部分 UI 借鉴了 Auggie (Augment CLI)。安装方式:
9+
10+
```bash
11+
npm install -g @autodev/cli
12+
````
13+
14+
---
15+
16+
### AutoDev CLI(本地模式)
17+
18+
```bash
19+
autodev code \
20+
--task "add Spring AI to project and also a service example, I use deepseek, here it's Spring AI documentation https://docs.spring.io/spring-ai/reference/api/chat/deepseek-chat.html 请先阅读文档!!" \
21+
-p /Users/phodal/IdeaProjects/untitled \
22+
--max-iterations 100
23+
```
24+
25+
---
26+
27+
### AutoDev CLI(远程模式)
28+
29+
```bash
30+
node dist/jsMain/typescript/index.js server \
31+
--task "编写 BlogService 测试" \
32+
--project-id https://github.com/unit-mesh/untitled \
33+
-s http://localhost:8080
34+
```
35+
36+
---
37+
38+
### AutoDev TUI 模式
39+
40+
```bash
41+
autodev .
42+
```
43+
44+
示例界面:
45+
46+
```
47+
┌──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
48+
│ 🤖 AutoDev CLI - AI Coding Assistant🤖 AI Agent - Ready (Project: untitled) │
49+
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
50+
ℹ️ System:
51+
🤖 **AI Agent Mode Activated**
52+
53+
Project: `/Users/phodal/IdeaProjects/untitled`
54+
55+
I'm ready to help you with development tasks. Just describe what you want me to do, and I'll work autonomously to complete it.
56+
57+
Type `/chat` to switch to chat mode, or `/help` for more commands.
58+
59+
INFO: [McpToolConfigManager] No MCP servers configured, skipping initialization
60+
┌──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
61+
│ > Type your message... (or /help for commands) │
62+
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
63+
Press Ctrl+C to exit | Type /help for commands | Ctrl+P to enhance prompt
64+
```

docs/mpp/autodev-mpp-android.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: AutoDev Android
3+
nav_order: 5
4+
parent: AutoDev MPP
5+
---
6+
7+
从 Release 页面下载最新的 Android App,然后安装即可。

docs/mpp/autodev-mpp-desktop.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: AutoDev Desktop
3+
nav_order: 6
4+
parent: AutoDev MPP
5+
---
6+
7+
AutoDev Desktop 是 AutoDev 的桌面应用,它基于 Compose 来构建,直接从 GitHub 发布页面下载即可。

docs/mpp/autodev-mpp-quickstart.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: AutoDev MPP Quickstart
3+
nav_order: 2
4+
parent: AutoDev MPP
5+
---
6+
7+
在本地配置模型,或者使用 GUI 配置。示例路径:
8+
9+
```bash
10+
➜ untitled git:(github) ✗ cat ~/.autodev/config.yaml
11+
```
12+
13+
代码:
14+
15+
`File(System.getProperty("user.home"), ".autodev/config.yaml")`
16+
17+
- 对于 Windows 来说,路径为 `C:\Users\<username>\.autodev\config.yaml`
18+
- 对于 macOS 来说,路径为 `~/.autodev/config.yaml`
19+
- 对于 Linux 来说,路径为 `~/.autodev/config.yaml`
20+
21+
配置示例:
22+
23+
```yaml
24+
active: deepseek
25+
configs:
26+
- name: deepseek
27+
provider: deepseek
28+
apiKey: sk-xxx
29+
model: deepseek-chat
30+
- name: glm-4
31+
provider: glm
32+
apiKey: xxx
33+
model: glm-4.6
34+
baseUrl: https://open.bigmodel.cn/api/paas/v4/
35+
temperature: 0.0
36+
maxTokens: 128000
37+
```

docs/mpp/autodev-remote.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: AutoDev Remote
3+
slug: autodev-remote
4+
nav_order: 4
5+
parent: AutoDev MPP
6+
---
7+
8+
AutoDev Remote 模式是将 AutoDev 作为远程服务来运行。其核心功能是:
9+
10+
- 提供 AutoDev 服务端,可以被任何客户端调用
11+
12+
需要从 release 页面下载 server.jar 然后在本地运行。在运行之前需要配置好模型。
13+
14+
启动日志示例:
15+
16+
```
17+
16:02:55.745 [main] INFO io.ktor.server.Application - Autoreload is disabled because the development mode is off.
18+
16:02:55.797 [main] INFO io.ktor.server.Application - Application started in 0.13 seconds.
19+
16:02:55.871 [DefaultDispatcher-worker-1] INFO io.ktor.server.Application - Responding at http://0.0.0.0:8080
20+
```

docs/mpp/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ AutoDev MPP 是 AutoDev 的多平台版本,它基于 Kotlin 的 Multiplatform
1414

1515
## Renderer
1616

17-
![](/img/next/renderer_architecture.svg))
17+
![](/img/next/renderer_architecture.svg)
1818

1919
统一了所有平台的渲染器接口规范,确保跨平台一致性。
2020

@@ -30,4 +30,3 @@ AutoDev MPP 是 AutoDev 的多平台版本,它基于 Kotlin 的 Multiplatform
3030
| **ServerRenderer** | mpp-server | extends BaseRenderer | ✅ 已统一 |
3131
| **TuiRenderer** | React/Ink TUI | implements Interface | ✅ 特殊架构 |
3232
| **ComposeRenderer** | Desktop/Android | extends BaseRenderer | ✅ 已统一 |
33-

0 commit comments

Comments
 (0)