快速开始

用源码版本验证 RuleOak v0.1.0

先从 GitHub 源码版本开始。确认测试、许可证、npm metadata 和 pack 内容检查都通过后，再决定是否嵌入到你的 agent 工作流。

1. 克隆并验证

git clone https://github.com/ruleoak/ruleoak.git
cd ruleoak
npm install --ignore-scripts
npm run check:publish
npm test

2. 先理解动作边界

RuleOak 应放在 agent 即将执行外部动作的位置，而不是只放在提示词或 UI 层。典型边界包括文件写入、shell 命令、git push、邮件发送、数据库变更、生产发布、MCP 工具调用、connector 写操作和 skill/plugin 安装。

3. 嵌入 core 决策点

import { evaluatePolicy } from "@ruleoak/core";

const decision = evaluatePolicy(policy, {
  actor: "agent:demo",
  action: "shell.run",
  target: "deploy-production",
  environment: "local"
});

// ALLOW: continue
// DENY: stop before execution
// APPROVAL: pause and record reviewer decision
// DRY_RUN: simulate and record evidence

建议接入顺序

先运行高风险 demo，确认团队能理解 allow、deny、approval 和 dry run 的行为；再把策略评估放进真实工具调用路径；最后把 Evidence JSONL 接入审计或回放流程。