快速开始 · v0.10.2
先运行安全 demo,再保护一个真实工具边界
v0.10.2 的推荐起点是 npm 上的 60 秒 demo,而不是先从源码 API 猜测用法。
1. 60 秒 demo
npx @ruleoak/cli@latest demo quickstartdemo 不执行破坏性或外部调用,会展示 ALLOW、NEEDS_APPROVAL、DENY,并在 .ruleoak-demo-output/ 下生成本地证据与离线 HTML 报告。
2. 保护 Node.js 进程的受支持工具流量
npx @ruleoak/cli@latest protect -- node agent.jsprotect 不是任意子进程内部行为监控器。要生效,工具动作必须通过 RuleOak 支持的边界,例如 MCP/JSON-RPC stdio 或显式 SDK 包装。
3. Node.js SDK
npx @ruleoak/cli@latest init --dir . --policy-pack cautious
npm install @ruleoak/coreimport { createRuleOak } from '@ruleoak/core'
const ruleoak = await createRuleOak({ workspace: '.' })
const guarded = ruleoak.guardFunction({
name: 'filesystem.read',
category: 'file',
operation: 'read',
resource: ([path]) => path,
scope: 'local',
sensitivity: 'public',
execute: readFile
})4. 本地检查
ruleoak doctor
ruleoak workspace status
ruleoak policy lint
ruleoak replay --verify
ruleoak approve生产式测试前
先阅读英文 Security 与 Compatibility 页面,并确认所有高影响执行路径都实际经过 RuleOak。
