Skip to content

Repository files navigation

SuperAI Agent

SuperAI Agent

GitHub Stars GitHub Forks GitHub Issues GitHub Pull Requests License 中文 English

SuperAI Agent 是一个本地可运行的 AI 编码代理:完整的终端 TUI、图形化桌面端,支持任意 Anthropic 兼容 API(MiniMax、OpenRouter 等)。内置 Computer Use(macOS / Windows)、记忆系统、多 Agent 编排,并可通过 Telegram / 飞书 / 微信公众号完整远程驱动

功能 · 桌面端 · 快速开始 · 环境变量 · FAQ · 全局使用 · 更多文档


功能

  • 完整的 Ink TUI 交互界面(与官方 Claude Code 一致)
  • --print 无头模式(脚本/CI 场景)
  • 支持 MCP 服务器、插件、Skills
  • 支持自定义 API 端点和模型(第三方模型使用指南
  • 记忆系统(跨会话持久化记忆)— 使用指南
  • 多 Agent 系统(多代理编排、并行任务、Teams 协作)— 使用指南 | 实现原理
  • Skills 系统(可扩展能力插件、自定义工作流)— 使用指南 | 实现原理
  • Channel 系统(通过 Telegram/飞书/Discord 等 IM 远程控制 Agent)— 架构解析
  • Computer Use 桌面控制功能指南 | 架构解析
  • 桌面端(Tauri 2 + React 图形化客户端,多标签多会话)— 文档
  • OpenAI Codex 官方提供商(通过本机 codex CLI 复用 ChatGPT 登录态,无需 API Key)— 接入指南
  • 降级 Recovery CLI 模式(CLAUDE_CODE_FORCE_RECOVERY_CLI=1 ./bin/superai-agent

桌面端

下载桌面端   安装指南

桌面端基于 Tauri 2 + React,支持多标签多会话、代码编辑与 Diff、权限控制、多提供商管理、定时任务,以及 Telegram / 飞书 / 微信公众号 IM 适配器。详见 桌面端文档


快速开始

1. 安装 Bun

# macOS / Linux
curl -fsSL https://bun.sh/install | bash

# macOS (Homebrew)
brew install bun

# Windows (PowerShell)
powershell -c "irm bun.sh/install.ps1 | iex"

精简版 Linux 如提示 unzip is required,先运行 apt update && apt install -y unzip

2. 安装依赖并配置

bun install
cp .env.example .env
# 编辑 .env 填入你的 API Key,详见 docs/guide/env-vars.md

3. 启动

macOS / Linux

./bin/superai-agent                          # 交互 TUI 模式
./bin/superai-agent -p "your prompt here"    # 无头模式
./bin/superai-agent --help                   # 查看所有选项

Windows

前置要求:必须安装 Git for Windows

# PowerShell / cmd 直接调用 Bun
bun --env-file=.env ./src/entrypoints/cli.tsx

# 或在 Git Bash 中运行
./bin/superai-agent

4. 全局使用(可选)

bin/ 加入 PATH 后可在任意目录启动,详见 全局使用指南

export PATH="$HOME/path/to/superai-agent/bin:$PATH"

5. 桌面端联调(Desktop)

如果你在开发或测试 desktop/ 前端,需要同时启动 API 服务端和桌面前端。

5.1 启动服务端

在项目根目录运行:

SERVER_PORT=3456 bun run src/server/index.ts

可选自检:

curl http://127.0.0.1:3456/health

5.2 启动桌面前端

cd desktop
bun run dev --host 127.0.0.1 --port 2024

然后在浏览器打开:

http://127.0.0.1:2024

5.3 常见注意事项

  • 如果 3456 端口已经被旧服务端占用,先执行 lsof -nP -iTCP:3456 -sTCP:LISTEN 找到 PID,再 kill <PID>
  • 测试聊天时建议新建一个 session,并重新选择一个真实存在的工作目录。
  • 如果某个旧 session 绑定的目录已被删除,服务端会返回 Working directory does not exist,这和服务端是否启动是两回事。

技术栈

类别 技术
运行时 Bun
语言 TypeScript
终端 UI React + Ink
CLI 解析 Commander.js
API Anthropic SDK
协议 MCP, LSP

更多文档

文档 说明
环境变量 完整环境变量参考和配置方式
第三方模型 接入 OpenAI / DeepSeek / Ollama 等非 Anthropic 模型
Codex 接入 通过本机 codex CLI 复用 ChatGPT 登录态作为提供商
记忆系统 跨会话持久化记忆的使用与实现
多 Agent 系统 多代理编排、并行任务执行与 Teams 协作
Skills 系统 可扩展能力插件、自定义工作流与条件激活
Channel 系统 通过 Telegram/飞书/Discord 等 IM 平台远程控制 Agent
Computer Use 桌面控制功能(截屏、鼠标、键盘)— 架构解析
桌面端 Tauri 2 + React 图形化客户端 — 快速上手 | 架构设计 | 安装指南
全局使用 在任意目录启动 superai-agent
常见问题 常见错误排查
源码修复记录 相对于原始泄露源码的修复内容
项目结构 代码目录结构说明

免责声明

本项目仅供学习与研究使用。使用过程中请遵守所对接 API 服务商的服务条款与相关法律法规。Claude Code 上游版权归 Anthropic 所有。

About

superai agent for personal study and useage

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages