Skip to content

Latest commit

 

History

283 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CoreMind(星枢智核)

把智能体工程经验变成新手也能执行、团队也能复用的标准。

阶段 Node.js 平台 文档 许可证

CLI/TUI · TypeScript SDK · Python SDK · 配置驱动 · Harness/Loop · SOP/Skill

快速开始 · 在线文档 · 仓库文档 · 功能模块 · 供应商矩阵 · 参与贡献 · English

CoreMind 面向没有智能体开发经验的新手和普通工程师,通过统一 Runtime 提供受控 Harness/Loop、CLI/TUI、TypeScript SDK、Python SDK,以及随功能同步交付的 SOP、Skill、双语指南和离线示例。

0.7.1 稳定版发布线已完成代码与文档准备,在 Protocol v2、Execution Security Gate、统一 Error Contract 与 Child Run 产品链路之上,补强凭据 Header、Artifact 导入、增量 Fact 持久化、Protocol v2 长驻 Host、TUI 输入和发布失败证据。公开可安装性以 GitHub ReleasenpmPyPI 实时页面为准。

仓库内 Provider 台账当前未收录 0.7.1 静态认证记录。正式发布必须通过绑定候选提交与 Runtime 摘要的 strict-provider 工作流 Artifact;可配置不等于认证,投产前应同时核对供应商矩阵与本版本工作流证据。

5 个黄金示例 · SOP/Skill 索引 · 版本迁移指南 · 已知限制 · 公开路线图 · 安全策略 · 社区行为准则

当前仓库具备什么能力

稳定版 0.7.1 坚持 CLI/TUI、TypeScript SDK、Python SDK 共用同一个 Runtime 与结果语义。

能力域 当前支持
开发入口 CLI/TUI、TypeScript SDK、Python SDK、完整源码
智能体编排 单 Agent、多 Agent、顺序/并行/条件 Workflow、公开 verify/repair Loop、无进展检测、暂停恢复与耗尽策略
配置与模型 Config v2;40 个可配置 Provider;自定义 OpenAI-compatible 端点;仓库台账未收录 0.7.1 静态记录,旧版本证据只供追溯;发布资格还须核对同版本 strict-provider 工作流 Artifact
工具与权限 内置文件、搜索、网页和脚本工具;TypeScript/Python 自定义工具;受控进程、只读 Git 与有上限的统一 Diff;askassistedfull 三档权限
可靠运行 明确的成功/失败/暂停/中止语义;turn/step/token/费用/工具预算;Trace、RunState、Session、Context 保护和安全恢复
协议与控制 Protocol v2 提供 RunHandle、cursor 续订、Projection query 与持久控制回执;v1 继续受支持,当前没有经批准的移除计划
执行环境 AgentDriver 隔离 reactive loop,ExecutionEnvironment probe 验证进程树、网络、凭据与隔离能力;Windows Trusted Host 不伪装成 sandbox,Linux sandbox 能力不足时失败关闭
变更保护 工作区路径策略、审批、写前 checkpoint、diff、显式恢复、审计;Linux 内置 shell 额外使用断网沙箱
质量工程 checkeval、三档质量门禁、场景评测、七类 grader、脏工作区保护、失败注入、三连跑、覆盖率基线、npm/wheel 干净安装和发布预检
编码智能体 先复现、再定位、最小修改、目标测试、回归测试和差异审查;当前离线 Coding Eval 6/6,二期真实外部同题模型对照尚未执行
新手学习 8 个场景模板、5 个离线黄金示例、2 个真实缺陷仓库、22 个能力模块;每个模块配套测试、SOP、Skill、中英文指南与示例
项目脚手架 新项目或已有工程接入;TypeScript、JavaScript、Python;生成代码/测试骨架、评测场景和项目级指导材料
当前平台 Windows 与 Linux;每个可发布候选都必须在同一源码提交完成自动矩阵、双平台 CI 与双平台真实伪终端,并完成真实 Provider 复验或明确、限版本、可审计的维护者裁决;安装状态以 Release 与 Registry 为准

当前不包含完整 Web 开发环境、官方托管 API、官方 Docker 镜像、纯 Python Runtime 和 macOS 正式支持。详见公开路线图

后续版本计划

阶段 计划能力 不变原则
0.3.1 稳定版(历史) 0.3.0 基础上完成事实域关联、类型化身份、不变量检查、请求重建、输入收据与取消收敛 保持 Config、Protocol、终态、权限、副作用和恢复合同由 CoreMind 持有
0.7.0 稳定版 汇总 0.3.x-B/C、Protocol v2、统一安全与错误合同,并把 Child Run 产品化到四个正式入口 Provider 网络例外已审计;真实认证仍是后续版本的独立门禁
0.7.1 稳定版 修复凭据 Header、Artifact 路径与身份、Fact 追加、Protocol v2 幂等状态、TUI 输入及发布证据问题 不改变 wire contract;Protocol v1 继续支持;Provider 认证必须按本版本重新取得
三期 Web 开发环境 可视化配置 Agent/工具/Workflow、在线代码编辑、Trace 调试、测试评测、权限审批、项目文件管理和发布指导 Web 复用 CoreMind Protocol,不建立另一套运行引擎
后续平台与生态 macOS 正式支持;持续扩展社区模板、Skill、Provider 证据和业务模块 每项能力必须同步交付实现、测试、SOP、Skill、中英文指南和示例

0.3.x 将以真实缺陷、社区反馈和发布证据为依据持续迭代。CoreMind 仍不会替用户决定业务目标、审批责任或智能体架构,也不计划提供官方 Docker 镜像或把框架变成托管 SaaS。

旧版本候选与 Provider 证据继续保留用于追溯,但不能替代 0.7.1 的发布或认证证据。

CoreMind 解决什么问题

CoreMind 让没有 Agent 开发经验的工程师先走一条标准路径:

  1. coremind create 新建项目或接入已有工程。
  2. 用 Config v2 明确 Agent、工具、预算、权限和质量档。
  3. runchat 开发,并查看审批、Trace、预算和 checkpoint。
  4. check 做静态质量门禁,用 eval 做业务场景评测。
  5. 按项目生成的需求、架构、SOP、测试指南、验收清单和 Skill 继续迭代。

框架不会替用户决定业务目标、数据字段、审批责任或 Agent 架构。用户负责业务与最终验收;CoreMind 负责机制保护、质量证据和开发指导。

三种使用方式

入口 适合谁 说明
CLI/TUI 第一次开发 Agent 的工程师 create/run/chat/check/eval/doctor/templates/providers 完整路径
嵌入式 SDK 在现有应用中集成 Agent TypeScript 直接调用统一 Runtime;Python 通过 stdio JSON-RPC 调用同一 Node Runtime
源码 需要扩展框架或参与社区开发 npm workspaces、TypeScript ESM、Python SDK、协议和模块合同全部开放

正式目标平台仍是 Windows 与 Linux;macOS 暂列为后续支持。Web 完整开发环境进入三期,当前不提供官方 Docker 镜像或托管 API 平台。

快速开始

使用源码开发需要 Node.js ≥ 22.19 与 npm ≥ 11.5.1。安装稳定版 CLI:

npm install -g coremind-cli@0.7.1
coremind providers
coremind create my-agent --template translator --language typescript --provider alibaba-model-studio
cd my-agent
copy .env.example .env
coremind check coremind.yaml
coremind run coremind.yaml --prompt "翻译:你好,世界"
coremind eval coremind.yaml

Linux 将 copy 换成 cp。交互终端会询问 Provider;脚本或 CI 必须显式传入 --provider,可用 coremind providers 查看清单。空目录会要求选择 TypeScript、JavaScript 或 Python;已有工程能唯一识别语言时自动判断,混合工程不会猜测。

生成的项目不仅有 coremind.yaml,还包括代码/测试骨架、evals/scenarios.yaml、中英文需求与架构、开发 SOP、测试指南、验收清单、项目 Skill、决策记录和 checkpoint 目录。已有文件不会被覆盖。

Config v2 最小安全配置

schemaVersion: 2
name: support-agent

provider:
  id: deepseek
  apiKeyEnv: DEEPSEEK_API_KEY

agents:
  main:
    systemPrompt: |
      只根据已确认的业务规则和工具结果回答;信息不足时明确说明。

runtime:
  maxTurns: 12
  maxSteps: 20
  maxToolCalls: 10
  maxToolFailures: 2
  maxRetries: 2
  runTimeoutMs: 120000

permissions:
  mode: ask
  workspaceOnly: true
  network: ask

quality:
  profile: standard
  minScenarioPassRate: 1
  allowOverride: true

权限模式:

  • ask:需要批准的工具逐项询问。
  • assisted:工作区内低风险文件操作自动批准,高风险操作询问。
  • full:不逐项询问,但显式 deny、审计、Trace 和 checkpoint 仍然生效;路径感知文件工具继续执行工作区策略。

delegate 使用更严格的矩阵:ask 每次询问;assisted 仅对 Config 显式 preapproved: true 且满足全部限制的目标自动批准;full 也不能覆盖 deny、allowlist、预算、工具不扩权、路径、网络或凭据边界。委派批准绑定固定输入指纹且只创建 Child Run,子级工具与外部 Effect 继续独立审批。

Linux 上的内置 bash 在 OS 级沙箱中运行,当前固定断网、只允许写工作区,并在沙箱不可用时关闭执行而不回退宿主 shell。Windows 一期没有 OS 级 shell 沙箱;宿主 Shell 只有在 full、workspaceOnly: falsenetwork: allow 同时选择时开放,其他组合安全拒绝。Git Bash 发现只提供命令兼容性,不提供隔离。CoreMind 不会把 checkpoint 描述成任意副作用的完整恢复。

Linux 沙箱依赖仍处于上游研究预览阶段,当前作为纵深防御能力使用;安全结论以完整权限策略、恢复机制和自动化测试证据为准。

CLI/TUI

coremind create <name>       新建项目或接入已有工程
coremind run <file>          无头运行;支持 --print、--json-events、--session、--resume
coremind chat <file>         多轮 TUI/readline;审批、预算、错误与 checkpoint
coremind check [file]        配置、安全、项目材料和质量档门禁
coremind eval [file]         重复运行 evals/scenarios.yaml
coremind doctor [file]       Node、配置与 Provider 环境自检
coremind templates           查看模板(兼容 list-templates)

run/chat/eval 可用 --permission ask|assisted|full 临时选择批准强度,但不会关闭安全边界和审计。TUI 支持 /status/children/checkpoints/diff <id>/restore <id>/abort/exit/children 从统一 Projection 展开 Child Run 层级、预算、Outcome、Recovery 与未处置风险。

coremind run 的退出码可直接用于 PowerShell、CI 和其他自动化:0 成功、1 失败、2 等待人工处理、3 预算耗尽、124 超时、130 中止。使用 --json-events 时,stdout 只输出 JSONL,最后一行固定为 type: "run_result" 的完整终态;诊断信息写入 stderr。--print--json-events 不能同时使用,避免机器输出混入普通文本。

TypeScript SDK

import {
  CoreMindRuntime,
  defineTool,
  loadConfigFile,
  parseAndValidate,
} from "coremind-ai";

const config = parseAndValidate(await loadConfigFile("coremind.yaml")).config;
const lookupOrder = defineTool<{ orderId: string }>({
  name: "lookup_order",
  description: "查询订单",
  parameters: {
    type: "object",
    properties: { orderId: { type: "string" } },
    required: ["orderId"],
  },
  effect: { operations: ["read"], reversible: true },
  execute: async ({ orderId }) => ({ orderId, status: "paid" }),
});

const runtime = await CoreMindRuntime.create({
  config,
  configDir: process.cwd(),
  initialPrompt: "查询 A-100",
  toolDefinitions: [lookupOrder],
  approveTool: async () => "allow",
});
const result = await runtime.run();
console.log(result.outcome, result.metrics, result.transcript);

Python SDK

Python SDK 启动一个常驻 Node worker,并使用相同的 Runtime 和结果语义;默认使用 Protocol v1,也可显式启用 Protocol v2。v1 继续受支持,当前没有经批准的移除计划。它不是第二套 Python Agent Loop。

from coremind import CoreMindClient

client = CoreMindClient("coremind.yaml", approval_handler=lambda request: "allow")

@client.tool(
    description="查询订单",
    effect={"operations": ["read"], "reversible": True},
)
def lookup_order(order_id: str) -> dict[str, str]:
    return {"id": order_id, "status": "paid"}

with client:
    result = client.run("查询 A-100")
print(result["outcome"], result["transcript"])

完整说明见 Python SDK 模块

Harness 与质量证据

  • 统一 RunOutcome / RunMetrics / EvaluationReport / ReleaseReadiness;成功、失败、暂停、中止、超时和预算耗尽都通过返回值表达,失败不能伪装为成功。
  • turn、step、工具调用/失败、重试、token、费用、步骤与总运行超时预算。
  • ask/assisted/full 三档权限,deny、路径和网络策略优先。
  • ask 模式下人工拒绝任一工具审批后,被拒绝项和本批次尚未审批的后续工具都会被阻断;本批结果归并后返回 paused,不会继续请求模型或重复弹出审批。顺序工作流中的拒绝步骤不会保存输出,后续步骤不会启动。
  • edit/write 前 checkpoint,运行后 diff 与显式恢复;恢复前检查工具完成后的文件指纹,检测到人工或并发修改时拒绝覆盖。
  • Artifact 只从允许的 canonical 临时普通文件导入;符号链接、越界真实路径或读取前身份变化都会被拒绝,删除临时源文件前还会再次核对身份。
  • Provider API key 与敏感 Header 必须使用环境变量引用或宿主 SecretRef;常见 Header 别名同样拒绝明文,解析失败时在任何 Provider、工具或 Fact 副作用前关闭执行。
  • 自定义工具必须声明 effect.operationseffect.reversible;权限层递归检查嵌套路径和 URL,未知副作用在受约束模式下安全拒绝。
  • Windows 宿主 Shell 只有在 full、关闭工作区限制、允许网络同时选择时开放,其他组合安全拒绝;Git Bash 不等于隔离;Linux Shell 继续使用操作系统级隔离。
  • 带 runId、eventId、sequence、timestamp 的 Trace 与 append-only RunState。
  • 意外中断后可从完整 step_output 边界继续;已结束运行、配置/输入不匹配或未完成步骤含非重放安全工具时明确拒绝恢复。
  • 每个工具调用写入幂等关联标识;业务工具仍需自行用该标识实现收据或去重,CoreMind 不承诺“恰好一次”。
  • Provider 调用前按实际模型与请求重新预算 Context;压缩使用事实投影的 TaskState,保留上一完整 Turn 与当前 user 消息,并把摘要和 lineage 持久化到 Session。无可持久化 Session、能力冲突或不可删除集合超限时在网络调用前暂停。
  • RunResult.snapshot 统一四个入口的 operation、outcome、指标、评测、Trace、Checkpoint、Artifact、扩展收据和恢复判断。
  • 生命周期扩展仅开放 before-model、before-tool、after-tool、run-finished 四个事件;能力与信任显式声明,默认不加载未知本地扩展。
  • 轻量 experiment → arm → run → trace 记录版本、输入指纹、环境、随机种子、运行结果和 grader,不建立第二套评测终态。
  • development、standard、strict 三档质量门禁;安全错误不可覆盖,其他覆盖必须记录原因并追加到 .coremind/quality-overrides.jsonl

Provider 策略

CoreMind 提供锁定的 40 个可配置 Provider 入口,也支持自定义 OpenAI-compatible 端点。可配置不等于 CoreMind Certified;当前认证必须在同一版本完成流式、工具调用、结构化结果、多轮、abort、错误映射和长上下文七项真实测试。仓库台账未收录 0.7.1 静态记录;正式发布必须另有绑定候选提交与 Runtime 摘要的 strict-provider 工作流 Artifact。0.7.0 的一次性网络例外与更早证据只供追溯,均不计为本版本认证。

默认无遥测。任何业务数据外传都必须由用户明确授权,密钥应使用 apiKeyEnv,不应写入 YAML。

查看自动生成的供应商矩阵认证 SOP

学习与验证材料

源码开发

npm ci
npm run build
npm run check
npm run test:stability
npm run test:coverage
npm run test:coding-evals
npm run build:python-worker
npm run release:check-npm
npm run release:test-npm
npm run release:test-source
python -X utf8 -m build --wheel python
npm run release:check-wheel

npm run check:modules 会检查 22 个模块与 5 个黄金示例的双语配对、Skill frontmatter、源码/测试路径、Markdown 链接、Config v2 和版本记录。CI 同时面向 Windows 与 Linux,连续三次执行 Node 测试,并验证覆盖率不下降、Python SDK、真实 Worker 一致性、黄金示例、编码缺陷评测、npm tarball 和 wheel 干净安装。P20 由目标平台真实伪终端自动验收;若自动脚本与人工可见界面出现差异,再补充人工复核记录。

开源协议

MIT · 参与贡献 · 安全策略 · 社区行为准则 · 上游组件声明见 THIRD_PARTY_NOTICES.md

About

配置驱动、可恢复的 Agent Runtime:CLI/TUI、TypeScript/Python SDK、Protocol v2、上下文压缩、Replay、Child Run 与安全执行环境

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

5 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages