快速开始 - AuraCode

1. 安装依赖

确保你的系统已安装 Python 3.10 或更高版本：

bash

python --version

安装所有依赖：

bash

pip install -r requirements.txt

提示

如果遇到依赖安装问题，可以尝试使用虚拟环境：

python -m venv venv
source venv/bin/activate  # Linux/Mac
venv\Scripts\activate     # Windows

2. 配置 API 密钥

AuraCode 支持多种 LLM，推荐使用智谱 GLM：

智谱 GLM（推荐）

bash

# Windows PowerShell
$env:OPENAI_API_KEY="your-api-key"
$env:OPENAI_BASE_URL="https://open.bigmodel.cn/api/paas/v4"

# Linux/Mac
export OPENAI_API_KEY="your-api-key"
export OPENAI_BASE_URL="https://open.bigmodel.cn/api/paas/v4"

OpenAI GPT

bash

export OPENAI_API_KEY="sk-your-key"

注意

请妥善保管你的 API 密钥，不要将其提交到版本控制系统。

3. 启动 AuraCode

AuraCode 提供多种启动方式：

方式 1: 多轮对话模式（推荐）

bash

python cli.py

方式 2: 带初始问题启动

bash

python cli.py "帮我分析这个项目"

方式 3: 命令模式（单次执行）

bash

python cli.py --command status

方式 4: Bridge 远程控制模式

bash

python cli.py --bridge --bridge-port 8765

4. 首次使用

启动后，你可以尝试以下命令：

/help 显示帮助信息

/status 查看系统状态

/init AI 分析代码库生成项目文档

/commit AI 智能生成 Git 提交

恭喜！

你已经成功安装并启动了 AuraCode。现在可以开始使用 AI 辅助编程了！

5. 权限设置

AuraCode 提供 4 种权限模式：

normal

文件写入和命令执行均需确认

默认

auto

文件操作自动通过，仅命令需确认

plan

只读模式，不允许修改文件

bypass

全部自动通过（谨慎使用）

危险

指定权限模式启动：

bash

python cli.py --mode auto "执行一些文件操作"

6. Bridge 远程控制

Bridge 提供 REST API + WebSocket 多会话远程控制：

bash

# 启动 Bridge 服务器
python cli.py --bridge --bridge-port 8765 --bridge-token my-secret

# 或在对话模式中
/bridge start --port 8765
/bridge status
/bridge stop

测试页面：用浏览器打开 bridge/test_bridge.html

API 端点

方法	路径	说明
POST	/api/sessions	创建新会话
GET	/api/sessions	列出所有会话
POST	/api/sessions/{id}/message	发送消息
WS	/ws/events	全局事件流

7. MCP 集成

支持 Model Context Protocol，可连接外部工具服务器：

yaml

# config.yaml 中配置 MCP 服务器
mcp:
  servers:
    - name: my-server
      transport: stdio  # stdio/http/websocket
      command: python my_mcp_server.py

支持能力

4 种传输协议: stdio / HTTP / WebSocket / SSE
工具适配: MCP 工具自动转为 OpenCode 工具
资源访问: 列出/读取 MCP 服务器资源
OAuth 认证: 支持 OAuth 2.0 认证流程