xykj-plus/claude-ecc/dev-assistant/bridge/README.md
2026-06-13 13:48:51 +08:00

3.2 KiB
Raw Permalink Blame History

@dev-assistant/bridge

AI 助手桥接服务 - 可集成到任何 Java 或 Node.js 项目。

快速开始

Docker 部署(推荐)

# 拉起镜像并运行(数据目录挂载到 ./dev-assistant-data
docker run --rm -v $(pwd)/dev-assistant-data:/data -p 9020:9020 --name dev-assistant-bridge

# 或者使用 docker-compose
docker compose up -f docker-compose.yml

配置文件

# 1. 复制示例配置到宿主目录
cp -r node_modules/@dev-assistant/bridge/config/dev-assistant.example.yaml ./dev-assistant.yaml

# 2. 编辑配置文件,根据你的项目调整:
#    - bridge.auth.verifyUrl: http://your-server:8080/api/auth/me
#    - workspace.root: ./your-project
#    - logs: 添加你的日志源路径

环境变量(可选)

docker run --rm -v $(pwd)/dev-assistant-data:/data \
  -e BRIDGE_AUTH_VERIFY_URL=http://your-server:8080/api/auth/me \
  -e DEV_ASSISTANT_WORKSPACE_ROOT=$(pwd)/your-project

功能特性

  • 多模型支持Anthropic、OpenAI、GLM、MiniMax 等
  • 工具审批破坏性工具Edit、Write、Bash需要用户确认
  • 上下文采集:浏览器控制台、网络请求、服务端日志
  • 实时通信WebSocket 双向协议,流式响应
  • 可插拔认证HTTP 远程验证、JWT 本地解析、无认证模式
  • 配置热加载:修改 YAML 配置文件后自动生效

配置说明

认证配置

bridge:
  auth:
    type: http              # http | jwt-local | disabled
    verifyUrl: http://localhost:8080/api/auth/me  # http only
    jwtSecret: ${JWT_SECRET}     # jwt-local only
    requiredRole: admin        # 管理员角色名

项目信息配置

project:
  name: my-project
  description: 我的项目描述
  techStack:
    - Spring Boot 3
    - React 18
  conventions:
    - 分层架构
    - RESTful API
  systemPrompt: "你是 ${project.name} 项目的开发助手..."

日志源配置

logs:
  - id: spring-server
    label: Spring Boot 应用日志
    path: /app/logs/app.log
    format: logback-json
    tailLines: 500

  - id: node-server
    label: Node.js 服务日志
    path: /var/log/node-server.log
    format: plain
    tailLines: 200

开发模式

NPM 包模式

# 安装到你的 Node.js 项目
npm install @dev-assistant/web-sdk

# 在代码中使用
import { mountDevAssistant } from '@dev-assistant/web-sdk';

mountDevAssistant({
  bridgeHttpUrl: 'http://localhost:9020',
  bridgeWsUrl: 'ws://localhost:9020/copilot',
  roles: ['ADMIN'],  # 你的管理员角色名
  userIdentifier: 'user-123',
  token: 'your-jwt-token',
});

独立程序模式

# 直接启动 bridge
node /path/to/@dev-assistant/bridge/dist/core/bridge-cli.js \
  --config ./my-config.yaml \
  --data-dir ./bridge-data

故障排查

  1. 检查日志:docker logs dev-assistant-bridge 查看启动日志
  2. 检查端口:确保 9020 端口未被占用
  3. 检查配置:--help 查看所有可用配置选项

文档


更多文档: GitHub Releases