kurihada
7f683a8aed
- 添加快速开始页面，包含安装、配置、启动指南 - 添加核心功能文档: Agent 系统、工具系统、MCP 集成 - 添加 API 参考文档: REST API、WebSocket、SDK 使用 - 更新侧边栏导航，重新组织文档分类 - 更新 .gitignore 允许 website docs 页面
195 lines
8.5 KiB
Plaintext
195 lines
8.5 KiB
Plaintext
---
|
|
import DocsLayout from '../../layouts/DocsLayout.astro';
|
|
---
|
|
|
|
<DocsLayout title="文档概览" description="AI Terminal Assistant 文档概览">
|
|
<h1>AI Terminal Assistant 文档</h1>
|
|
|
|
<p>
|
|
欢迎来到 AI Terminal Assistant 文档。这是一个功能完整的终端 AI 编程助手，
|
|
支持流式对话、工具调用、代码检查点、多模型支持等特性。
|
|
</p>
|
|
|
|
<h2>项目简介</h2>
|
|
|
|
<p>
|
|
AI Terminal Assistant 采用 Monorepo 架构，核心引擎已实现完整的 Agent 系统、
|
|
工具链、检查点和扩展机制。支持 Web、桌面、CLI 多端访问。
|
|
</p>
|
|
|
|
<div class="not-prose my-6 rounded-xl border border-gray-800 bg-gray-900/50 p-6">
|
|
<pre class="text-sm text-gray-300 overflow-x-auto"><code>ai-terminal-assistant/
|
|
├── packages/
|
|
│ ├── core/ # 核心引擎：Agent、工具、LSP、Checkpoint
|
|
│ ├── server/ # HTTP 服务器：REST API、WebSocket、SSE
|
|
│ ├── cli/ # 命令行界面
|
|
│ ├── web/ # React 前端
|
|
│ └── desktop/ # Tauri 桌面应用
|
|
└── docs/ # 设计文档</code></pre>
|
|
</div>
|
|
|
|
<h2>核心能力</h2>
|
|
|
|
<div class="grid gap-4 md:grid-cols-2 not-prose my-6">
|
|
<div class="rounded-xl border border-gray-800 bg-gray-900/50 p-5">
|
|
<div class="mb-3 flex h-10 w-10 items-center justify-center rounded-lg bg-gradient-to-br from-blue-500 to-cyan-500 text-lg">⚡</div>
|
|
<h3 class="mb-2 text-lg font-semibold text-white">Agent 系统</h3>
|
|
<p class="text-sm text-gray-400">完整的 Agent 引擎，支持流式响应、工具调用、Vision 处理、Plan 模式</p>
|
|
</div>
|
|
|
|
<div class="rounded-xl border border-gray-800 bg-gray-900/50 p-5">
|
|
<div class="mb-3 flex h-10 w-10 items-center justify-center rounded-lg bg-gradient-to-br from-green-500 to-emerald-500 text-lg">🛠️</div>
|
|
<h3 class="mb-2 text-lg font-semibold text-white">工具系统</h3>
|
|
<p class="text-sm text-gray-400">23+ 内置工具（Shell、文件、Git、搜索、Web 等），支持动态加载和语义搜索</p>
|
|
</div>
|
|
|
|
<div class="rounded-xl border border-gray-800 bg-gray-900/50 p-5">
|
|
<div class="mb-3 flex h-10 w-10 items-center justify-center rounded-lg bg-gradient-to-br from-purple-500 to-violet-500 text-lg">💾</div>
|
|
<h3 class="mb-2 text-lg font-semibold text-white">Checkpoint 系统</h3>
|
|
<p class="text-sm text-gray-400">Shadow Git 架构、7点安全检查、创建/恢复/撤销恢复</p>
|
|
</div>
|
|
|
|
<div class="rounded-xl border border-gray-800 bg-gray-900/50 p-5">
|
|
<div class="mb-3 flex h-10 w-10 items-center justify-center rounded-lg bg-gradient-to-br from-pink-500 to-rose-500 text-lg">🔌</div>
|
|
<h3 class="mb-2 text-lg font-semibold text-white">MCP 集成</h3>
|
|
<p class="text-sm text-gray-400">完整的 Model Context Protocol 支持，通过外部工具扩展 AI 能力</p>
|
|
</div>
|
|
</div>
|
|
|
|
<h2>快速导航</h2>
|
|
|
|
<div class="grid gap-4 md:grid-cols-2 not-prose mt-6">
|
|
<a href="/docs/quickstart" class="block rounded-xl border border-gray-800 bg-gray-900/50 p-6 transition hover:border-primary-500/50 hover:bg-gray-900">
|
|
<h3 class="mb-2 text-lg font-semibold text-white">🚀 快速开始</h3>
|
|
<p class="text-sm text-gray-400">5 分钟内启动并运行</p>
|
|
</a>
|
|
|
|
<a href="/docs/architecture" class="block rounded-xl border border-gray-800 bg-gray-900/50 p-6 transition hover:border-primary-500/50 hover:bg-gray-900">
|
|
<h3 class="mb-2 text-lg font-semibold text-white">🏗️ 架构设计</h3>
|
|
<p class="text-sm text-gray-400">了解系统架构和模块设计</p>
|
|
</a>
|
|
|
|
<a href="/docs/core/agent" class="block rounded-xl border border-gray-800 bg-gray-900/50 p-6 transition hover:border-primary-500/50 hover:bg-gray-900">
|
|
<h3 class="mb-2 text-lg font-semibold text-white">🤖 Agent 系统</h3>
|
|
<p class="text-sm text-gray-400">深入了解 AI Agent 引擎</p>
|
|
</a>
|
|
|
|
<a href="/docs/api/rest" class="block rounded-xl border border-gray-800 bg-gray-900/50 p-6 transition hover:border-primary-500/50 hover:bg-gray-900">
|
|
<h3 class="mb-2 text-lg font-semibold text-white">📡 API 参考</h3>
|
|
<p class="text-sm text-gray-400">REST API 和 WebSocket 文档</p>
|
|
</a>
|
|
</div>
|
|
|
|
<h2>功能状态</h2>
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>功能</th>
|
|
<th>状态</th>
|
|
<th>描述</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a href="/docs/core/agent">Agent 系统</a></td>
|
|
<td><span class="text-green-400">✅ 已完成</span></td>
|
|
<td>流式响应、工具调用、多轮对话、Vision 支持</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/docs/core/tools">工具系统</a></td>
|
|
<td><span class="text-green-400">✅ 已完成</span></td>
|
|
<td>23+ 内置工具，支持动态加载</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/docs/features/edit-modes">编辑模式</a></td>
|
|
<td><span class="text-green-400">✅ 已完成</span></td>
|
|
<td>Whole、Search-Replace、Diff 三种模式</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/docs/features/checkpoint">Checkpoint</a></td>
|
|
<td><span class="text-green-400">✅ 已完成</span></td>
|
|
<td>Shadow Git 架构，7点安全检查</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/docs/features/chat-history">会话管理</a></td>
|
|
<td><span class="text-green-400">✅ 已完成</span></td>
|
|
<td>三层存储、自动保存、消息压缩</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/docs/core/mcp">MCP 集成</a></td>
|
|
<td><span class="text-green-400">✅ 已完成</span></td>
|
|
<td>完整的 Model Context Protocol 支持</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/docs/features/multi-model">多模型支持</a></td>
|
|
<td><span class="text-green-400">✅ 已完成</span></td>
|
|
<td>Claude、OpenAI、DeepSeek 等</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/docs/features/browser-gui">Web GUI</a></td>
|
|
<td><span class="text-green-400">✅ 已完成</span></td>
|
|
<td>React 前端 + WebSocket 实时通信</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/docs/features/configuration">配置管理</a></td>
|
|
<td><span class="text-yellow-400">🔧 部分实现</span></td>
|
|
<td>支持配置加载，完整多层配置待完善</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/docs/features/linting">Linting 集成</a></td>
|
|
<td><span class="text-gray-400">📋 规划中</span></td>
|
|
<td>代码编辑后自动运行 linter</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="/docs/features/testing">测试集成</a></td>
|
|
<td><span class="text-gray-400">📋 规划中</span></td>
|
|
<td>代码修改后自动运行测试</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<h2>开发路线图</h2>
|
|
|
|
<h3>✅ 已完成</h3>
|
|
<ul>
|
|
<li><strong>Phase 1</strong> - 核心引擎：Agent、工具、编辑、检查点</li>
|
|
<li><strong>Phase 2</strong> - Server 层：REST API、WebSocket、SSE</li>
|
|
<li><strong>Phase 3</strong> - 前端应用：Web、桌面、CLI</li>
|
|
<li><strong>Phase 4</strong> - 扩展系统：MCP、Hooks、Commands</li>
|
|
</ul>
|
|
|
|
<h3>🚧 进行中</h3>
|
|
<ol>
|
|
<li>配置管理增强 - 完善多层配置系统</li>
|
|
<li>LSP 深度集成 - 代码诊断和补全</li>
|
|
</ol>
|
|
|
|
<h3>📋 计划中</h3>
|
|
<ol>
|
|
<li>Linting 集成 - 代码编辑后自动运行 linter</li>
|
|
<li>测试集成 - 代码修改后自动运行测试</li>
|
|
<li>Watch 模式 - 文件监控和 AI 注释处理</li>
|
|
<li>语音输入 - 语音转文字交互</li>
|
|
</ol>
|
|
|
|
<h2>获取帮助</h2>
|
|
|
|
<div class="grid gap-4 md:grid-cols-3 not-prose mt-6">
|
|
<a href="https://github.com" target="_blank" rel="noopener" class="block rounded-xl border border-gray-800 bg-gray-900/50 p-5 transition hover:border-gray-700 hover:bg-gray-900">
|
|
<h3 class="mb-2 text-base font-semibold text-white">GitHub</h3>
|
|
<p class="text-sm text-gray-400">源代码和 Issues</p>
|
|
</a>
|
|
|
|
<a href="https://discord.com" target="_blank" rel="noopener" class="block rounded-xl border border-gray-800 bg-gray-900/50 p-5 transition hover:border-gray-700 hover:bg-gray-900">
|
|
<h3 class="mb-2 text-base font-semibold text-white">Discord</h3>
|
|
<p class="text-sm text-gray-400">社区讨论</p>
|
|
</a>
|
|
|
|
<a href="/docs/quickstart" class="block rounded-xl border border-gray-800 bg-gray-900/50 p-5 transition hover:border-gray-700 hover:bg-gray-900">
|
|
<h3 class="mb-2 text-base font-semibold text-white">快速开始</h3>
|
|
<p class="text-sm text-gray-400">开始使用</p>
|
|
</a>
|
|
</div>
|
|
</DocsLayout>
|