Skip to content

Repository files navigation

SPCode

SPCode 是一款面向课程大作业交付的编码 Agent 工具。项目由 Python 后端和 TypeScript OpenTUI 前端组成:后端负责软件过程控制、Agent Loop、工具调用、检查点、质量门禁和模型访问,前端提供交互式终端编码体验。

推荐工作流如下:

init -> plan -> build -> test -> review/repair -> compact -> export

快速开始

运行要求:

  • Python 3.11 或更高版本
  • Node.js 20 或更高版本,并已安装 npm

在 SPCode 仓库根目录运行:

npm run setup

该命令会安装 npm 依赖、编译检查 Python 后端、通过 npm link 将本地 npm 包注册为全局命令,并验证 spcode 已经可以在 PATH 中使用。

部署完成后,打开任意项目目录并运行:

spcode

这会在当前目录启动全屏 TUI,启动方式接近 OpenCode。也可以使用非交互式命令:

spcode --help
spcode model list
spcode tui --snapshot --no-color
spcode build --agent-loop --request "实现下一个功能"

模型配置

复制 .env.example.env 并填写 API 信息。若 .env 不存在,npm run setup 会自动根据 .env.example 创建一份。

ANTHROPIC_BASE_URL=...
ANTHROPIC_AUTH_TOKEN=...
ANTHROPIC_MODEL=glm-5.1

可选模型 ID:

  • glm-5.1
  • kimi-k2.6
  • mimo-v2.5-pro
  • deepseek-v4-pro

切换模型:

spcode model set kimi-k2.6
spcode model current

仓库结构

  • bin/:npm 全局命令 spcode 的启动器。
  • frontend/tui/:TypeScript OpenTUI 前端。
  • scripts/:一键部署脚本和环境检查脚本。
  • spcode/:Python 后端,包括过程引擎、Agent Loop、工具、记忆、会话、检查点和 TUI 后端。
  • docs/:安装、使用、项目结构和交付检查文档。
  • .env.example:模型 API 配置模板。
  • SPAGENTS.md:面向 Agent 协作开发的项目规则。

验证

验证 npm 启动器和 TUI:

npm run verify

验证 Python 后端:

python -m unittest discover -s spcode -p "test*.py"
python -m compileall spcode

检查本机部署状态:

npm run doctor
spcode --version
spcode tui --snapshot --no-color

文档

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages