codespring

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

CodeSpring CLI

Manage project planning: workspaces, projects, tasks, PRDs, and mindmaps.

用于项目规划管理：工作区、项目、任务、PRD和思维导图。

Prerequisites

前置条件

CLI installed:

npm i -g @codespring/cli

or use

bunx @codespring/cli

Authenticated: Run

codespring auth status

to check. Login with

codespring auth login

Project linked: Check for
```
.codespring/config.json
```
or run
```
codespring init
```
.

已安装CLI：执行

npm i -g @codespring/cli

，或直接使用

bunx @codespring/cli

已完成身份认证：运行
```
codespring auth status
```
检查认证状态，使用
```
codespring auth login
```
登录
已关联项目：检查是否存在
```
.codespring/config.json
```
，若没有则运行
```
codespring init
```
。

Quick Start

快速开始

bash

undefined

bash

undefined

1. Check auth

1. 检查认证状态

codespring auth status

2. Link project (interactive — picks workspace → project → writes config)

2. 关联项目（交互模式——选择工作区 → 选择项目 → 写入配置）

codespring init

3. Start working

3. 开始使用

codespring tasks --status todo

undefined

codespring tasks --status todo

undefined

Core Commands

核心命令

Command	Purpose
`codespring workspaces`	List available workspaces
`codespring projects [--org ID]`	List projects in a workspace
`codespring features`	List features for linked project
`codespring tasks [--status S] [--feature ID]`	List tasks with filters
`codespring task start <id>`	Mark task as in_progress
`codespring task done <id>`	Mark task as done
`codespring prds`	List PRDs by feature structure
`codespring prd <id>`	Get full PRD content
`codespring prd sync <id> --file <path>`	Update PRD from file
`codespring mindmap`	Get mindmap structure
`codespring mindmap tech-stack --add '<json>'`	Sync tech stack
`codespring mindmap features --add '<json>'`	Sync features
`codespring mindmap note <featureId> --text '...'`	Add feature notes
`codespring schema`	Data schema reference
`codespring node-types`	Mindmap node type reference

命令	用途
`codespring workspaces`	列出可用工作区
`codespring projects [--org ID]`	列出指定工作区下的项目
`codespring features`	列出已关联项目的功能点
`codespring tasks [--status S] [--feature ID]`	按筛选条件列出任务
`codespring task start <id>`	将任务标记为进行中
`codespring task done <id>`	将任务标记为已完成
`codespring prds`	按功能结构列出PRD
`codespring prd <id>`	获取完整PRD内容
`codespring prd sync <id> --file <path>`	从文件更新PRD
`codespring mindmap`	获取思维导图结构
`codespring mindmap tech-stack --add '<json>'`	同步技术栈
`codespring mindmap features --add '<json>'`	同步功能点
`codespring mindmap note <featureId> --text '...'`	为功能点添加备注
`codespring schema`	数据模式参考
`codespring node-types`	思维导图节点类型参考

Output

输出

All commands output JSON. Add

--pretty

for human-readable formatting. Use

--help

on any command for full options.

所有命令默认输出JSON格式，添加

--pretty

参数可生成易读的格式化输出。任意命令后添加

--help

可查看完整参数选项。

Agentic Task Workflow

智能任务工作流

bash

undefined

bash

undefined

1. Find available work

1. 查找待处理工作

codespring tasks --status todo

2. Claim a task

2. 认领任务

codespring task start <task-id>

3. Do the work using your coding tools

3. 使用你的编码工具完成开发工作

4. Mark done

4. 标记任务完成

codespring task done <task-id>

undefined

codespring task done <task-id>

undefined

Syncing Codebase Analysis

同步代码库分析结果

After analyzing a codebase, sync findings:

bash

undefined

完成代码库分析后，可同步分析结果：

bash

undefined

Sync detected technologies

同步检测到的技术栈

codespring mindmap tech-stack --add '[{"id":"tech-react","title":"React","description":"Frontend"}]'

Sync discovered features

同步发现的功能点

codespring mindmap features --add '[{"title":"Authentication","description":"User login/signup"}]'

Add analysis notes to a feature

为功能点添加分析备注

codespring mindmap note feature-auth --text "Uses OAuth2 with PKCE flow..."

undefined

codespring mindmap note feature-auth --text "Uses OAuth2 with PKCE flow..."

undefined

Detailed References

详细参考文档

commands.md — Full CLI reference with all flags
task-workflow.md — Agentic task execution patterns
analyze-codebase.md — Codebase analysis checklist
mindmap-structure.md — Mindmap data formats and node types
prd-management.md — PRD export and sync workflows

commands.md — 完整CLI参考文档，包含所有参数
task-workflow.md — 智能任务执行模式说明
analyze-codebase.md — 代码库分析检查清单
mindmap-structure.md — 思维导图数据格式与节点类型说明
prd-management.md — PRD导出与同步工作流说明