Skip to content

free-revalution/DevBoost

BranchesTags

Repository files navigation

DevBoost

跨平台嵌入式开发智能助手 / Cross-platform embedded development agent

Tests License Node

简介 / Introduction

DevBoost 是一款跨平台的桌面端 AI 助手，专为嵌入式开发者设计。它能够帮助你：

  • 🤖 智能对话: 通过自然语言与 AI 助手交互，完成各种开发任务
  • 📁 项目管理: 自动创建和管理嵌入式项目（支持 STM32CubeMX、Keil5、Arduino IDE）
  • 🌐 浏览器自动化: 自动操作浏览器，在嘉立创等平台绘制电路图和 PCB
  • 🔧 代码生成: 自动生成嵌入式代码，配置项目参数
  • 📊 可视化操作: 通过 TUI（终端用户界面）实时查看操作进度

DevBoost is an AI-powered development assistant designed for embedded systems development. It provides:

  • 🤖 Natural Language Interaction: Interact with the AI assistant through natural language
  • 📁 Project Management: Automatically create and manage embedded projects (STM32CubeMX, Keil5, Arduino IDE)
  • 🌐 Browser Automation: Automate browser interactions for PCB design on platforms like JLCPCB
  • 🔧 Code Generation: Automatically generate embedded code and configure project parameters
  • 📊 Visual Interface: Real-time progress monitoring through TUI (Terminal User Interface)

快速开始 / Quick Start

环境要求 / Requirements

  • Node.js >= 22.0.0
  • pnpm >= 9.0.0

安装 / Installation

# 克隆仓库 / Clone repository
git clone git@github.com:free-revalution/DevBoost.git
cd DevBoost

# 安装依赖 / Install dependencies
pnpm install

# 构建项目 / Build project
pnpm build

配置 API Key / Configure API Key

DevBoost 支持多种 LLM 提供商 / DevBoost supports multiple LLM providers:

# Anthropic Claude (默认/default)
export ANTHROPIC_API_KEY="your-api-key-here"

# OpenAI
export OPENAI_API_KEY="your-api-key-here"

# Ollama (本地/local)
export OLLAMA_API_KEY="your-api-key-here"

运行 / Run

# 方式1: 简单模式 (推荐/Recommended) - 无需 TUI
pnpm start:simple
# 或
node packages/cli/dist/cli-entry.js --no-tui

# 方式2: TUI 模式 (完整界面)
pnpm start
# 或
node packages/cli/dist/cli-entry.js

# 方式3: 查看帮助
node packages/cli/dist/cli-entry.js --help

全局安装 / Global Installation

想要在任何地方使用 DevBoost 命令 / To use DevBoost command from anywhere:

# 全局安装 / Install globally
pnpm run install:global

# 然后可以直接使用 / Then you can use directly:
DevBoost                    # 启动 TUI 模式 / Start TUI mode
DevBoost --no-tui            # 启动简单模式 / Start simple mode
DevBoost --help             # 显示帮助 / Show help

# 不区分大小写 / Case-insensitive:
devboost                    # 也可以工作 / Also works
DEVBOOST                    # 也可以工作 / Also works

卸载全局命令 / Uninstall global command:

pnpm run uninstall:global

注意 / Note: 如果 TUI 模式在终端中出现乱码或错误，请使用简单模式 (--no-tui)。

使用指南 / Usage Guide

TUI 界面 / TUI Interface

启动后会显示交互式界面 / After starting, you'll see the interactive interface:

┌─────────────────────────────────────────────────────────────┐
│                    DevBoost CLI v0.1.0                      │
├─────────────────────────────────────────────────────────────┤
│                                                             │
│  Conversation                    Tasks                      │
│  ┌─────────────────────────┐     ┌──────────────────┐       │
│  │ > 你好                   │     │  ○ 任务1          │      │
│  │ < 你好！有什么可以帮助你？  │     │  ◉ 任务2 (进行中)  │       │
│  │                         │     │  ● 任务3          │       │
│  └─────────────────────────┘     └──────────────────┘       │
│                                                             │
│  [READY] Ready for input. Type /help for available commands │
│  > 输入命令或消息...                                           │
└─────────────────────────────────────────────────────────────┘

可用命令 / Available Commands

以 / 开头的命令 / Commands starting with /:

命令 Command 说明 Description 示例 Example
/help 显示帮助信息 / Show help /help
/agent start 启动 AI Agent / Start Agent /agent start
/agent stop 停止 AI Agent / Stop Agent /agent stop
/agent status 查看 Agent 状态 / Agent status /agent status
/agent restart 重启 Agent / Restart Agent /agent restart
/context clear 清空对话上下文 / Clear context /context clear
/context save [name] 保存上下文 / Save context /context save session1
/context load [name] 加载上下文 / Load context /context load session1
/context info 上下文信息 / Context info /context info
/tools 列出可用工具 / List tools /tools
/history [count] 对话历史 / Chat history /history 10
/clear 清空屏幕 / Clear screen /clear
/provider list 列出 LLM 提供商 / List providers /provider list
/devboost info 项目信息 / Project info /devboost info

使用示例 / Usage Examples

创建嵌入式项目 / Create Embedded Project

> 帮我创建一个 STM32F103 项目
> Help me create an STM32F103 project

配置 CubeMX

> 打开 CubeMX，配置 UART1 波特率为 115200
> Open CubeMX and configure UART1 baudrate to 115200

编译代码 / Compile Code

> 编译当前项目
> Compile the current project

烧录固件 / Flash Firmware

> 将固件烧录到开发板
> Flash the firmware to the board

配置文件 / Configuration File

配置文件位置 / Config file location: .devboost/

.devboost/
├── config.json       # 元数据配置
├── models.json       # 模型配置（含 API Key）
├── context/          # 对话记录目录
│   └── context.json  # 对话历史
└── sessions/         # Telegram 会话
    └── sessions.json

添加模型 / Add Model

启动后使用交互式命令添加模型 / Use interactive commands after starting:

/model add                          # 开始添加
/model provider anthropic            # 选择提供商
/model name claude-3-5-sonnet-20241022  # 模型名称
/model key sk-ant-xxxxx              # API Key
/model confirm                       # 确认添加

支持的提供商 / Supported providers:

  • anthropic: Claude 3.5 Sonnet, Claude 3 Opus
  • openai: GPT-4, GPT-3.5 Turbo
  • openai-compatible: OpenAI 兼容 API（需填写 Base URL）
  • ollama: 本地模型（如 llama2, mistral）

详细说明请查看 / See docs/MODEL_SETUP.md

支持的 LLM 提供商 / Supported LLM Providers

  • Anthropic: Claude 3.5 Sonnet, Claude 3 Opus
  • OpenAI: GPT-4, GPT-3.5 Turbo
  • OpenAI Compatible: 兼容 OpenAI API 的服务 / OpenAI-compatible services
  • Ollama: 本地运行的模型 / Local models

开发 / Development

项目结构 / Project Structure

DevBoost/
├── packages/
│   ├── core/          # 核心 Agent 实现 / Core Agent
│   ├── cli/           # CLI 界面 / CLI Interface
│   ├── tui/           # TUI 组件 / TUI Components
│   ├── tools/         # 工具集合 / Tools Collection
│   └── automation/    # 自动化模块 / Automation Module
├── docs/              # 文档 / Documentation
└── 文档/              # 中文文档 / Chinese Docs

运行测试 / Run Tests

# 运行所有测试 / Run all tests
pnpm test

# 运行特定包的测试 / Run specific package tests
pnpm --filter @devboost/core test
pnpm --filter @devboost/cli test

构建 / Build

# 构建所有包 / Build all packages
pnpm build

# 构建特定包 / Build specific package
pnpm --filter @devboost/cli build

路线图 / Roadmap

  • 核心 Agent 框架 / Core Agent Framework
  • TUI 界面 / TUI Interface
  • 命令处理系统 / Command System
  • 配置管理 / Configuration Management
  • 浏览器自动化 / Browser Automation (Playwright)
  • GUI 自动化 / GUI Automation (@nut-tree/nut-js)
  • CubeMX 集成 / STM32CubeMX Integration
  • Keil5 集成 / Keil5 Integration
  • Arduino IDE 集成 / Arduino IDE Integration

贡献 / Contributing

欢迎提交 Issue 和 Pull Request！ Issues and Pull Requests are welcome!

许可证 / License

MIT License

致谢 / Acknowledgments

  • pi-mono - 项目灵感来源 / Project Inspiration
  • Claude Code - AI 辅助开发 / AI-assisted Development
  • Blessed - TUI 框架 / TUI Framework

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages