@costrict/csc

中文文档
4.2.50发布于 2026/11/05ES Module近 30 天下载 2.5万

costrict

原始使用文档
文档目录24 节
  1. CoStrict 是什么
  2. 快速开始
  3. 安装版
  4. 源码版
  5. 首次登录
  6. CoStrict 专有模块
  7. 企业认证体系 ( src/costrict/provider/ )
  8. 结构化 Agent ( src/costrict/agents/ )
  9. CoStrict 技能 ( src/costrict/skill/ )
  10. API 多协议兼容
  11. 架构总览
  12. CLI 入口快速路径
  13. 工具体系
  14. 内置工具分类
  15. MCP 扩展
  16. Feature Flag 体系
  17. 默认启用(Dev + Build)
  18. 按需启用
  19. Workspace Packages
  20. 测试与质量
  21. 开发调试
  22. 常用脚本
  23. VS Code 调试
  24. 终端 Agent 状态

CoStrict

企业级 AI 编程助手 · 终端原生

快速开始 · 架构 · 部署 · API 协议 · CoStrict 专有模块


CoStrict 是什么

CoStrict 是一款免费开源的 AI 辅助编程工具,专为企业级开发场景设计。支持私有化部署,是组织级安全、标准化 AI 开发工作流的最佳选择。

能力说明
CoStrict 企业认证OAuth 2.0 + Casdoor SSO,自动 Token 刷新,机器指纹绑定
8 种 API 协议CoStrict / Anthropic / OpenAI / Gemini / Grok / Bedrock / Vertex / Foundry
53+ 内置工具文件读写、Shell 执行、Web 搜索、Agent 调度、MCP 扩展——开箱即用
16 个结构化 Agent严格需求分析→架构设计→任务规划→编码→验证全链路编排
私有化部署Remote Control Server (Docker) + Bridge Mode,数据不出内网
Feature Flag 体系19+ 默认特性 + 环境变量热开关,按需启用零代码改动
安全合规权限模式分级、Policy 策略网关、Worktree 隔离、审计日志
全平台macOS / Windows / Linux,Computer Use + Chrome Use 双通道 UI 自动化

快速开始

安装版

bun i -g @costrict/xxx
csc

源码版

环境要求:Bun >= 1.2.0

git clone https://github.com/y574444354/csc.git
cd csc
bun install
bun run dev       # 版本号显示 888 即成功
bun run build     # 生产构建 → dist/cli.js + chunk 文件

首次登录

启动后输入 /login,CoStrict 提供两种认证入口:

1. CoStrict 企业登录(推荐)

浏览器自动打开 CoStrict OAuth 页面,完成 SSO 登录后自动写入凭证:

/login → 选择 CoStrict → 浏览器 SSO 登录 → 自动完成
  • 认证服务:https://zgsm.sangfor.com/oidc-auth
  • 凭证存储:~/.claude/csc-auth.json(0600 权限)
  • 自动刷新:三层 Token 验证 + 预防性刷新 + 401 反应性恢复

2. 第三方 API 直连

选择 Anthropic Compatible / OpenAI / Gemini 填写 Base URL 和 API Key:

字段说明示例
Base URLAPI 服务地址https://api.example.com/v1
API Key认证密钥sk-xxx
Haiku Model快速模型claude-haiku-4-5-20251001
Sonnet Model均衡模型claude-sonnet-4-6
Opus Model高性能模型claude-opus-4-6

也可直接编辑 ~/.claude/settings.json:

{
  "env": {
    "ANTHROPIC_BASE_URL": "https://api.example.com/v1",
    "ANTHROPIC_AUTH_TOKEN": "sk-xxx",
    "ANTHROPIC_DEFAULT_HAIKU_MODEL": "claude-haiku-4-5-20251001",
    "ANTHROPIC_DEFAULT_SONNET_MODEL": "claude-sonnet-4-6",
    "ANTHROPIC_DEFAULT_OPUS_MODEL": "claude-opus-4-6"
  }
}

CoStrict 专有模块

企业认证体系 (src/costrict/provider/)

模块职责
auth.tsOAuth 2.0 登录流程:浏览器跳转、Token 轮询、凭证保存
credentials.ts凭证管理:读写 csc-auth.json、机器指纹 SHA256 生成
token.tsToken 生命周期:JWT 解析、三层验证、自动刷新
fetch.ts请求中间件:动态注入 Authorization + 自定义 Headers、预防性/反应性 Token 刷新
oauth-params.tsOAuth 参数构建:Casdoor provider 标识、插件版本、URI Scheme
models.ts动态模型列表:从 AI Gateway 拉取可用模型,1 小时缓存
modelMapping.ts模型名解析:5 级优先级映射 Anthropic 模型名到 CoStrict 模型 ID
index.ts查询入口:复用 OpenAI 兼容路径,注入 CoStrict fetch 和 baseURL

Token 刷新策略:

请求发起 → 读取凭证 → Token 是否过期?
  ├─ 否 → 正常请求(注入 Authorization + X-Costrict-* headers)
  └─ 是 → refresh_token 刷新 → 成功?
       ├─ 是 → 更新凭证 → 正常请求
       └─ 否 → 使用旧 Token 尝试 → 401?
            ├─ 是 → 再次刷新 → 重试请求
            └─ 否 → 返回原始响应

模型名解析优先级:

  1. 传入 model 已是已知 CoStrict 模型 ID(用户 /model 明确选择)
  2. COSTRICT_MODEL 环境变量(管理员全局覆盖)
  3. COSTRICT_DEFAULT_{HAIKU|SONNET|OPUS}_MODEL 环境变量(按族映射)
  4. 缓存模型列表的第一个可用模型
  5. 透传原始模型名(兜底)

结构化 Agent (src/costrict/agents/)

CoStrict 提供严格分阶段的 Agent 编排,覆盖从需求到交付的全链路:

Agent阶段职责
strictSpec需求需求澄清 → 架构设计 → 任务规划 → 执行(四阶段工作流)
requirement需求用户需求 → 结构化系统需求文档
designAgent设计需求文档 → C4 Model 架构设计
taskPlan规划需求 + 设计 → 高层次任务规划
strictPlan规划用户需求 → 可执行实施计划
subCoding编码高效低成本的代码实现
taskCheck验证任务质量检查与改进
tddTestDesign测试功能需求 → 测试用例设计
tddTestPrepare测试测试环境准备
tddRunAndFix测试执行验证 → 自动修复
tddTestAndFix测试测试执行与诊断修复
codeReviewSecurity安全代码安全审计
quickExplore探索快速项目探索与代码理解
wikiProjectAnalyze文档项目分类分析
wikiCatalogueDesign文档文档结构设计
wikiDocumentGenerate文档技术文档生成
wikiIndexGeneration文档索引文档生成

StrictSpec 全链路编排:

用户需求 → StrictSpec
  ├─ Stage 1: Requirement → 结构化需求文档
  ├─ Stage 2: DesignAgent → C4 Model 架构设计
  ├─ Stage 3: TaskPlan → 任务规划
  └─ Stage 4: SubCoding → 编码实现

CoStrict 技能 (src/costrict/skill/)

技能说明
projectWiki项目文档体系生成(分析→设计→生成→索引)
tddTDD 全流程(设计→准备→执行→修复)
builtin内置技能注册与索引

API 多协议兼容

CoStrict 通过流适配器模式将所有 API 协议转为内部统一格式,下游代码零改动。

协议启用方式适用场景
CoStrict/login 选 CoStrict 或 CLAUDE_CODE_USE_COSTRICT=1企业 SSO + AI Gateway 动态模型
Anthropic默认原生 Messages API
OpenAICLAUDE_CODE_USE_OPENAI=1Ollama / DeepSeek / vLLM
GeminiCLAUDE_CODE_USE_GEMINI=1Google Gemini API
xAI GrokCLAUDE_CODE_USE_GROK=1xAI Grok API
AWS BedrockCLAUDE_CODE_USE_BEDROCK=1AWS Bedrock
Google VertexCLAUDE_CODE_USE_VERTEX=1Vertex AI
FoundryCLAUDE_CODE_USE_FOUNDRY=1Anthropic Foundry

架构总览

┌───────────────────────────────────────────────────────────┐
│  CLI 入口 (cli.tsx) — 12 快速路径 + main.tsx 完整 CLI     │
├───────────────────────────────────────────────────────────┤
│  REPL 对话循环                                             │
│  REPL.tsx → QueryEngine → query() → API Client            │
│  流式响应 · Tool 调度 · 上下文压缩 · 记忆管理             │
├───────────────┬───────────────────────────────────────────┤
│  CoStrict 专有 │            通用工具层                     │
│  ┌──────────┐ │  ┌─────────────────────────────────────┐  │
│  │ Provider  │ │  │ 53+ 内置工具                        │  │
│  │  OAuth    │ │  │ 文件 / Shell / Agent / Web / MCP   │  │
│  │  Token    │ │  │ Cron / Worktree / LSP / Skill      │  │
│  │  Fetch    │ │  └─────────────────────────────────────┘  │
│  │ Models    │ ├───────────────────────────────────────────┤
│  │ Mapping   │ │            Agent 编排层                   │
│  └──────────┘ │  ┌─────────────────────────────────────┐  │
│  ┌──────────┐ │  │ CoStrict Agents (16)                │  │
│  │ Agents   │ │  │ StrictSpec · TDD · Wiki · Security  │  │
│  │  (16)    │ │  └─────────────────────────────────────┘  │
│  └──────────┘ │  ┌─────────────────────────────────────┐  │
│  ┌──────────┐ │  │ 通用 Agents                         │  │
│  │ Skills   │ │  │ AgentTool · Team · Coordinator      │  │
│  │  (3)     │ │  │ Fork Subagent · Worktree 隔离       │  │
│  └──────────┘ │  └─────────────────────────────────────┘  │
├───────────────┴───────────────────────────────────────────┤
│  API 兼容层 (8 协议) → 统一流适配器 → 下游代码零改动     │
├───────────────────────────────────────────────────────────┤
│  基础设施                                                 │
│  Feature Flag · Daemon · Bridge/RCS · Voice Mode          │
│  BG Sessions · Policy 网关 · Sentry · GrowthBook          │
└───────────────────────────────────────────────────────────┘

CLI 入口快速路径

命令说明Feature Gate
--version版本输出:4.0.1 (CoStrict)—
--claude-in-chrome-mcpChrome 浏览器控制 MCP—
--computer-use-mcpComputer Use MCPCHICAGO_MCP
rc / bridge / remote-controlBridge 模式BRIDGE_MODE
daemon守护进程DAEMON
ps / logs / attach / kill后台会话管理BG_SESSIONS
new / list / replyTemplate 任务TEMPLATES
environment-runnerBYOC 环境运行器BYOC_ENVIRONMENT_RUNNER
self-hosted-runner自托管运行器SELF_HOSTED_RUNNER
--tmux + --worktreeTmux 工作区隔离—
默认路径完整 REPL CLI—

工具体系

内置工具分类

分类工具说明
文件操作FileReadTool FileEditTool FileWriteTool GlobTool GrepTool代码读写与搜索
Shell 执行BashTool PowerShellTool REPLTool命令执行与交互式 REPL
Agent 协作AgentTool TaskCreateTool TaskUpdateTool TaskListTool TaskGetTool TaskOutputTool TaskStopTool多 Agent 任务调度
团队编排TeamCreateTool TeamDeleteTool SendMessageToolAgent Team 编排
规划验证EnterPlanModeTool ExitPlanModeTool VerifyPlanExecutionTool结构化规划与验证
Web 网络WebFetchTool WebSearchTool WebBrowserTool网页获取/搜索/浏览器自动化
MCP 扩展MCPTool McpAuthTool ListMcpResourcesTool ReadMcpResourceToolModel Context Protocol
调度定时CronCreateTool CronDeleteTool CronListToolCron 定时任务
工作区EnterWorktreeTool ExitWorktreeToolGit Worktree 隔离
交互辅助AskUserQuestionTool TodoWriteTool SkillTool ToolSearchTool DiscoverSkillsTool ConfigTool用户交互与配置
开发辅助LSPTool NotebookEditTool BriefToolLSP / Notebook / 会话摘要
远程触发RemoteTriggerTool MonitorTool远程 Agent 触发与监控
高级特性SleepTool SnipTool WorkflowTool TungstenToolProactive / 工作流 / 实验性

MCP 扩展

csc mcp serve     # 启动 MCP 服务器
csc mcp add       # 添加 MCP 服务
csc mcp list      # 列出已配置服务

Feature Flag 体系

所有特性通过 FEATURE_<FLAG_NAME>=1 环境变量按需启用。

默认启用(Dev + Build)

优先级Feature说明
核心BUDDY宠物伙伴
核心TRANSCRIPT_CLASSIFIER会话自动分类
核心BRIDGE_MODEBridge / Remote Control
核心AGENT_TRIGGERS_REMOTE远程 Agent 触发
核心CHICAGO_MCPComputer Use MCP
核心VOICE_MODE语音输入
监控SHOT_STATS统计面板
监控PROMPT_CACHE_BREAK_DETECTION缓存断裂检测
监控TOKEN_BUDGETToken 预算管理
P0AGENT_TRIGGERS本地 Agent 触发
P0ULTRATHINK深度思考
P0BUILTIN_EXPLORE_PLAN_AGENTS内置探索/规划 Agent
P0LODESTONELodestone
P1EXTRACT_MEMORIES记忆提取
P1VERIFICATION_AGENT验证 Agent
P1KAIROS_BRIEFKairos 摘要
P1AWAY_SUMMARY离线摘要
P1ULTRAPLAN超级规划
P2DAEMON守护进程

按需启用

Feature说明
BG_SESSIONS后台会话 (ps/logs/attach/kill)
FORK_SUBAGENTFork 子 Agent 并行执行
PROACTIVE主动式 Agent
KAIROSKairos 全功能
COORDINATOR_MODECoordinator 协调模式
TEMPLATESTemplate 任务系统
SSH_REMOTESSH 远程连接
WEB_BROWSER_TOOL浏览器自动化
WORKFLOW_SCRIPTS工作流脚本
BYOC_ENVIRONMENT_RUNNERBYOC 环境运行器
SELF_HOSTED_RUNNER自托管运行器
FEATURE_FORK_SUBAGENT=1 FEATURE_BG_SESSIONS=1 bun run dev

Workspace Packages

Package说明状态
@ant/inkForked Ink 终端 UI 框架完整
@ant/computer-use-mcpComputer Use MCP Server完整
@ant/computer-use-input键鼠模拟 (多平台 backend)完整
@ant/computer-use-swift截图 + 应用管理 (多平台)完整
@ant/claude-for-chrome-mcpChrome 浏览器控制完整
remote-control-server自托管 RCS (Docker + Web UI)完整
audio-capture-napi原生音频捕获已恢复
image-processor-napi图像处理已恢复
color-diff-napi颜色差异计算完整
modifiers-napi键盘修饰键检测Stub
url-handler-napiURL scheme 处理Stub

测试与质量

指标数据
测试数量2430 tests
测试文件137 files
断言调用3982 expect()
框架bun:test
LintBiome
FormatBiome
bun test                                       # 全量测试
bun test src/utils/__tests__/hash.test.ts       # 单文件
bun test --coverage                            # 覆盖率
bun run lint                                    # 静态检查
bun run health                                  # 健康检查

开发调试

常用脚本

命令说明
bun run dev开发模式(MACRO + 全 Feature)
bun run dev:inspect带 Inspector 的开发模式
bun run build生产构建 (code splitting)
bun run lint:fix自动修复 Lint
bun run format格式化
bun run health健康检查
bun run generate:skills生成 Skills 索引
bun run rcs启动 RCS
bun run docs:dev文档站 (Mintlify)

VS Code 调试

bun run dev:inspect   # → ws://localhost:8888/xxx
# VS Code: F5 → "Attach to Bun (TUI debug)"

终端 Agent 状态

交互式 TTY 默认支持 OSC 7501,可在 herdr Agents 栏展示工作、等待授权/回答、完成及失败状态。使用 CSC_OSC7501=0 csc 关闭。详见 终端状态协议说明。

版本与发布记录

@costrict/csc 共发布 113 个版本,首次发布于 2026/04/10;过去 12 个月发布了 113 个版本。

版本发布日期距今
4.2.50latest2026/11/055 天前
4.2.482026/10/2912 天前
4.2.48-betabeta2026/10/2813 天前
4.2.472026/10/2714 天前
4.2.462026/10/2615 天前
4.2.452026/10/2021 天前

其他发布通道:try-run → 4.0.5-3,beta → 4.2.48-beta。

关于 @costrict/csc 的常见问题

@costrict/csc 是什么?

costrict

如何安装 @costrict/csc?

在项目目录运行 npm install @costrict/csc,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 csc,可以用 npx csc 直接运行。

@costrict/csc 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/costrict__csc 是否存在。

@costrict/csc 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@costrict/csc 可以商用吗?

@costrict/csc 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@costrict/csc 的下载量有多少?

根据 npm 官方下载统计,@costrict/csc 在 2026/10/11 – 2026/11/09 这 30 天内被下载 24,894 次,日均约 830 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@costrict/csc 还在维护吗?

最新版本 4.2.50 发布于 2026/11/05(5 天前);至今共发布 113 个版本,其中过去 12 个月发布了 113 个;首次发布于 2026/04/10。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。