claude-flow 3.72.2 → 3.73.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/proven-config.json +1 -1
- package/.claude-plugin/marketplace.json +2 -2
- package/README.md +29 -21
- package/README.zh-CN.md +69 -4
- package/node_modules/@claude-flow/codex/dist/cli.js +0 -0
- package/node_modules/@claude-flow/plugin-agent-federation/dist/bin.js +0 -0
- package/node_modules/@claude-flow/plugin-agent-federation/package.json +5 -5
- package/node_modules/@claude-flow/security/dist/input-validator.d.ts +6 -6
- package/package.json +2 -2
- package/v3/@claude-flow/cli/README.md +29 -21
- package/v3/@claude-flow/cli/catalog-manifest.json +2 -2
- package/v3/@claude-flow/cli/dist/src/commands/agent.js +2 -0
- package/v3/@claude-flow/cli/dist/src/commands/funnel.d.ts +1 -0
- package/v3/@claude-flow/cli/dist/src/commands/funnel.js +37 -2
- package/v3/@claude-flow/cli/dist/src/commands/hooks.js +16 -2
- package/v3/@claude-flow/cli/dist/src/commands/init.js +70 -16
- package/v3/@claude-flow/cli/dist/src/commands/mcp.js +15 -0
- package/v3/@claude-flow/cli/dist/src/commands/swarm.js +2 -0
- package/v3/@claude-flow/cli/dist/src/funnel/activation.d.ts +30 -0
- package/v3/@claude-flow/cli/dist/src/funnel/activation.js +69 -0
- package/v3/@claude-flow/cli/dist/src/funnel/events.js +4 -1
- package/v3/@claude-flow/cli/dist/src/funnel/index.d.ts +2 -1
- package/v3/@claude-flow/cli/dist/src/funnel/index.js +2 -1
- package/v3/@claude-flow/cli/dist/src/funnel/message-transport.d.ts +12 -0
- package/v3/@claude-flow/cli/dist/src/funnel/message-transport.js +23 -1
- package/v3/@claude-flow/cli/dist/src/funnel/types.d.ts +2 -2
- package/v3/@claude-flow/cli/dist/src/init/first-win.d.ts +24 -0
- package/v3/@claude-flow/cli/dist/src/init/first-win.js +97 -0
- package/v3/@claude-flow/cli/dist/src/mcp-tools/agent-tools.js +2 -0
- package/v3/@claude-flow/cli/dist/src/mcp-tools/swarm-tools.js +2 -0
- package/v3/@claude-flow/cli/dist/src/missions/schemas.d.ts +117 -117
- package/v3/@claude-flow/cli/dist/src/mods/command-registry/schema.d.ts +121 -121
- package/v3/@claude-flow/cli/dist/src/transfer/store/download.d.ts +1 -1
- package/v3/@claude-flow/cli/dist/src/transfer/store/download.js +22 -21
- package/v3/@claude-flow/cli/dist/src/transfer/store/publish.d.ts +1 -1
- package/v3/@claude-flow/cli/dist/src/transfer/store/publish.js +13 -14
- package/v3/@claude-flow/cli/package.json +5 -5
|
@@ -80,9 +80,9 @@
|
|
|
80
80
|
"url": "https://github.com/ruvnet/agentic-flow.git",
|
|
81
81
|
"path": "plugins/agentic-flow",
|
|
82
82
|
"ref": "main",
|
|
83
|
-
"sha": "
|
|
83
|
+
"sha": "d19737b8574c956d17d695f09113e8b445d965b0"
|
|
84
84
|
},
|
|
85
|
-
"description": "agentic-flow (external: maintained in ruvnet/agentic-flow, pinned to commit
|
|
85
|
+
"description": "agentic-flow (external: maintained in ruvnet/agentic-flow, pinned to commit d19737b, plugin 3.4.0): the agentic-flow MCP server pinned to agentic-flow@3.4.0 (ReasoningBank learning, ecosystem tools prompt_injection_scan, swarm_partition_tasks, sublinear_solve, sublinear_pagerank and ecosystem_status, multi-provider routing, autopilot learning; readonly profile by default, no tool pre-approved), 2 agents, 4 skills, /agentic-flow-status, and a mod guard on agentic_flow_agent with /agentic-flow-guard"
|
|
86
86
|
},
|
|
87
87
|
{
|
|
88
88
|
"name": "ruflo-docs",
|
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
<!-- Try Ruflo — the 3 badges first-time visitors actually act on -->
|
|
8
8
|
[](https://www.npmjs.com/package/ruflo)
|
|
9
9
|
[](https://opensource.org/licenses/MIT)
|
|
10
|
-
[](https://github.com/ruvnet/ruflo)
|
|
11
11
|
[](https://x.com/rUv)
|
|
12
12
|
|
|
13
13
|
<p align="center">
|
|
@@ -23,42 +23,49 @@
|
|
|
23
23
|
|
|
24
24
|
<a id="start-here"></a>
|
|
25
25
|
|
|
26
|
-
## <img src="docs/assets/readme/icons/terminal.svg" width="32" height="32" alt=""> Get started
|
|
26
|
+
## <img src="docs/assets/readme/icons/terminal.svg" width="32" height="32" alt=""> Get started in one command
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
Run this in your project folder:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
npx ruflo@latest init
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Then open Claude Code in the same folder and give it a real task, for example:
|
|
29
35
|
|
|
30
36
|
```text
|
|
31
|
-
|
|
32
|
-
/plugin install ruflo-core@ruflo
|
|
33
|
-
/plugin install ruflo-console@ruflo
|
|
34
|
-
/plugin install ruflo-mods@ruflo
|
|
35
|
-
/reload-plugins
|
|
36
|
-
/ruflo
|
|
37
|
+
Use a ruflo swarm to review this repo: find the riskiest module, write tests for it, and summarise what you changed.
|
|
37
38
|
```
|
|
38
39
|
|
|
39
|
-
|
|
40
|
+
`init` adds ruflo's agents, hooks, memory and MCP server to the project, and Claude Code picks them up on its next start. Codex and other MCP clients work too: point them at `npx -y ruflo@latest mcp start`.
|
|
40
41
|
|
|
41
|
-
|
|
42
|
+
<p align="center"><img src="docs/assets/ruflo-console-tour.gif" width="720" alt="Looping recording of the ruflo console: overview, swarm view and missions in a sample project"></p>
|
|
42
43
|
|
|
43
|
-
|
|
44
|
+
[First useful task, step by step](docs/ruflo-explained.md) · [User guide](docs/USERGUIDE.md) · [Compare install paths](#quick-start)
|
|
44
45
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
```
|
|
46
|
+
<details>
|
|
47
|
+
<summary><b>Other ways to install</b> (Claude Code plugins only, MCP-only clients, terminal UI)</summary>
|
|
48
48
|
|
|
49
|
-
|
|
49
|
+
**Claude Code plugins only.** This route installs core tools, the visual console and runtime mods, with no files added to your project. It needs Claude Code **2.1.287 or later**. Run inside Claude Code:
|
|
50
50
|
|
|
51
|
-
```
|
|
52
|
-
|
|
51
|
+
```text
|
|
52
|
+
/plugin marketplace add ruvnet/ruflo
|
|
53
|
+
/plugin install ruflo-core@ruflo
|
|
54
|
+
/plugin install ruflo-console@ruflo
|
|
55
|
+
/plugin install ruflo-mods@ruflo
|
|
56
|
+
/reload-plugins
|
|
57
|
+
/ruflo
|
|
53
58
|
```
|
|
54
59
|
|
|
55
|
-
|
|
60
|
+
From a terminal, on Claude Code 2.1.292 or later: `claude plugin install ruflo-core@ruflo --marketplace ruvnet/ruflo`. Mods run with your account's permissions, so review their code before installing.
|
|
61
|
+
|
|
62
|
+
**Codex or another MCP client, without project setup.** Configure the **command** `npx` with the **arguments** `["-y", "ruflo@latest", "mcp", "start"]`. To set up a project interactively, run `npx ruflo@latest init wizard`.
|
|
56
63
|
|
|
57
|
-
|
|
64
|
+
**Plain terminal.** The console also runs on its own, without Claude Code: `npx ruflo tui`. Add `--plain` to print one frame for scripts. See the [terminal UI guide](docs/USERGUIDE.md#terminal-ui-optional).
|
|
58
65
|
|
|
59
66
|
<p align="center"><img src="docs/assets/ruflo-tui-compact.svg" width="640" alt="Looping recording of the optional ruflo terminal UI with its pictures: Overview in the Classic BBS look, the Orbital look with its moving globe, and the Swarm graph, in a sample project"></p>
|
|
60
67
|
|
|
61
|
-
|
|
68
|
+
</details>
|
|
62
69
|
|
|
63
70
|
<div align="center">
|
|
64
71
|
|
|
@@ -484,6 +491,7 @@ Four docs for four audiences:
|
|
|
484
491
|
|-----|-----------------|
|
|
485
492
|
| **[Status](docs/STATUS.md)** | See what currently works — capability counts, test baselines, recent fixes, what's next. The *is-it-ready* doc. |
|
|
486
493
|
| **[User Guide](docs/USERGUIDE.md)** | Daily reference — every command, every config flag, every plugin. The *how-do-I* doc. |
|
|
494
|
+
| **[Compare frameworks](docs/compare.md)** | Deciding between Ruflo, Claude Code built-in agents, CrewAI, LangGraph, or AutoGen. The *which-one-for-me* doc. |
|
|
487
495
|
| **[MetaHarness Guide](docs/metaharness-user-guide.md)** | How to grade your agent setup, scan tool configs for security, detect changes between runs, and eject a project into a standalone agent toolkit. The *audit-my-setup* doc. |
|
|
488
496
|
| **[Benchmarks](https://gist.github.com/ruvnet/298f8c668c8859b369f91734a0e9cbbe)** | v3.8.0 SOTA matrix vs LangGraph / AutoGen / CrewAI on darwin-arm64 + linux-x64. ruflo wins cold start, single turn, RSS by 1.3×–1953×. The *is-it-fast* doc. |
|
|
489
497
|
| **[Verification](verification.md)** | Cryptographically prove your installed bytes match the signed witness — `ruflo verify`. The *trust-but-verify* doc. |
|
package/README.zh-CN.md
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<a href="https://cognitum.one/agentic-engineering"><img src="ruflo/assets/ruflo-neon-flicker.gif" alt="Ruflo animated neon sign" width="100%"></a>
|
|
4
|
+
|
|
5
|
+
**面向 Claude Code 与 Codex 的智能体元基座(meta-harness)。**
|
|
4
6
|
|
|
5
7
|
<!-- Try Ruflo — the 3 badges first-time visitors actually act on -->
|
|
6
8
|
[](https://www.npmjs.com/package/ruflo)
|
|
7
9
|
[](https://opensource.org/licenses/MIT)
|
|
8
|
-
[](https://github.com/ruvnet/ruflo)
|
|
9
11
|
|
|
10
12
|
<!-- Ecosystem strip (collapsed visually with flat-square) -->
|
|
11
13
|
[](https://github.com/ruvnet/ruvector)
|
|
@@ -14,12 +16,75 @@
|
|
|
14
16
|
[](https://github.com/ruvnet/claude-flow)
|
|
15
17
|
[](https://www.npmjs.com/package/@claude-flow/codex)
|
|
16
18
|
|
|
19
|
+
<a id="start-here"></a>
|
|
20
|
+
|
|
21
|
+
## <img src="docs/assets/readme/icons/terminal.svg" width="32" height="32" alt=""> 一条命令快速开始
|
|
22
|
+
|
|
23
|
+
在你的项目文件夹中运行:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npx ruflo@latest init
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
然后在同一文件夹打开 Claude Code 并给它一个真实的任务,例如:
|
|
30
|
+
|
|
31
|
+
```text
|
|
32
|
+
用 ruflo 蜂群来审查这个代码库:找出风险最高的模块,为它写测试,总结你改了什么。
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
`init` 会为项目添加 ruflo 的智能体、钩子、记忆和 MCP 服务器。Claude Code 在下次启动时会自动识别它们。Codex 和其他 MCP 客户端也支持:只需指向 `npx -y ruflo@latest mcp start`。
|
|
36
|
+
|
|
37
|
+
<p align="center"><img src="docs/assets/ruflo-console-tour.gif" width="720" alt="ruflo 控制台演示:概览、蜂群视图和任务"></p>
|
|
38
|
+
|
|
39
|
+
[第一个实用任务,逐步讲解](docs/ruflo-explained.md) · [用户指南](docs/USERGUIDE.md) · [比较安装路径](#快速开始)
|
|
40
|
+
|
|
41
|
+
<details>
|
|
42
|
+
<summary><b>其他安装方式</b>(仅 Claude Code 插件、MCP 客户端、终端 UI)</summary>
|
|
43
|
+
|
|
44
|
+
**仅 Claude Code 插件。** 这种方式安装核心工具、可视控制台和运行时 mod,无需向项目添加文件。需要 Claude Code **2.1.287 或更高版本**。在 Claude Code 中运行:
|
|
45
|
+
|
|
46
|
+
```text
|
|
47
|
+
/plugin marketplace add ruvnet/ruflo
|
|
48
|
+
/plugin install ruflo-core@ruflo
|
|
49
|
+
/plugin install ruflo-console@ruflo
|
|
50
|
+
/plugin install ruflo-mods@ruflo
|
|
51
|
+
/reload-plugins
|
|
52
|
+
/ruflo
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
从终端运行(Claude Code 2.1.292 或更高版本):`claude plugin install ruflo-core@ruflo --marketplace ruvnet/ruflo`。Mod 运行在你的账户权限下,安装前请审查代码。
|
|
56
|
+
|
|
57
|
+
**Codex 或其他 MCP 客户端,无需项目配置。** 配置 **命令** 为 `npx`,**参数** 为 `["-y", "ruflo@latest", "mcp", "start"]`。要进行交互式项目配置,运行 `npx ruflo@latest init wizard`。
|
|
58
|
+
|
|
59
|
+
**纯终端。** 控制台也可独立运行,无需 Claude Code:`npx ruflo tui`。加上 `--plain` 为脚本打印单一画面。详见[终端 UI 指南](docs/USERGUIDE.md#terminal-ui-optional)。
|
|
60
|
+
|
|
61
|
+
<p align="center"><img src="docs/assets/ruflo-tui-compact.svg" width="640" alt="可选的 ruflo 终端 UI 及其界面:经典 BBS 外观、带移动地球的 Orbital 外观、和蜂群图表"></p>
|
|
62
|
+
|
|
63
|
+
</details>
|
|
64
|
+
|
|
65
|
+
<div align="center">
|
|
66
|
+
|
|
67
|
+
### 可选:ruOS Desktop
|
|
68
|
+
|
|
69
|
+
<a href="https://ruos.cognitum.one"><img src="ruflo/assets/ruos-animated.svg" alt="ruOS — 一个能自己运行的桌面" width="100%"></a>
|
|
70
|
+
|
|
71
|
+
**通过 MCP 将 ruOS 连接到 ChatGPT 或 Claude:**
|
|
72
|
+
|
|
73
|
+
```text
|
|
74
|
+
https://ruos.cognitum.one/mcp
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
<!-- RuVector promo -->
|
|
78
|
+
<a href="https://github.com/ruvnet/ruvector"><img src="docs/assets/readme/ruvector-promo-depth.svg" width="100%" alt="RuVector:给智能体加装记忆。本地向量搜索、持久上下文、图关系、反馈学习。探索 RuVector。"></a>
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
npx ruvector
|
|
82
|
+
```
|
|
83
|
+
|
|
17
84
|
# Ruflo
|
|
18
85
|
|
|
19
86
|
[English](README.md) · [简体中文](README.zh-CN.md)
|
|
20
87
|
|
|
21
|
-
**面向 Claude Code 与 Codex 的智能体元基座(meta-harness)。**
|
|
22
|
-
|
|
23
88
|
[](docs/ruflo-explained.md)
|
|
24
89
|
|
|
25
90
|
**[📖 RuFlo 详解——组建一支会规划、会记忆、会测试、会自我改进的 AI 团队](docs/ruflo-explained.md)**
|
|
File without changes
|
|
File without changes
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@claude-flow/plugin-agent-federation",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.7",
|
|
4
4
|
"description": "Cross-installation agent federation with zero-trust security, PII-gated data flow, and compliance-grade audit trails.",
|
|
5
5
|
"homepage": "https://github.com/ruvnet/ruflo",
|
|
6
6
|
"type": "module",
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
"@claude-flow/shared": "^3.0.0",
|
|
27
27
|
"@claude-flow/security": "^3.0.0",
|
|
28
28
|
"@types/ws": "^8.18.1",
|
|
29
|
-
"agentic-flow": "2.0.
|
|
29
|
+
"agentic-flow": "2.0.14",
|
|
30
30
|
"typescript": "^5.4.0",
|
|
31
31
|
"vitest": "^4.1.0"
|
|
32
32
|
},
|
|
@@ -46,11 +46,11 @@
|
|
|
46
46
|
"sourceDependencies": {
|
|
47
47
|
"dependencies": {
|
|
48
48
|
"@noble/ed25519": "^2.0.0",
|
|
49
|
-
"ws": "^8.
|
|
49
|
+
"ws": "^8.21.0"
|
|
50
50
|
},
|
|
51
51
|
"peerDependencies": {
|
|
52
|
-
"agentic-flow": "
|
|
53
|
-
"midstreamer": "
|
|
52
|
+
"agentic-flow": "^2.0.14 || ^3.0.0",
|
|
53
|
+
"midstreamer": "^0.3.2"
|
|
54
54
|
},
|
|
55
55
|
"peerDependenciesMeta": {
|
|
56
56
|
"agentic-flow": {
|
|
@@ -159,14 +159,14 @@ export declare const SpawnAgentSchema: z.ZodObject<{
|
|
|
159
159
|
timeout: z.ZodOptional<z.ZodNumber>;
|
|
160
160
|
}, "strip", z.ZodTypeAny, {
|
|
161
161
|
type: "coder" | "reviewer" | "tester" | "planner" | "researcher" | "security-architect" | "security-auditor" | "memory-specialist" | "swarm-specialist" | "integration-architect" | "performance-engineer" | "core-architect" | "test-architect" | "queen-coordinator" | "project-coordinator";
|
|
162
|
+
id?: string | undefined;
|
|
162
163
|
config?: Record<string, unknown> | undefined;
|
|
163
164
|
timeout?: number | undefined;
|
|
164
|
-
id?: string | undefined;
|
|
165
165
|
}, {
|
|
166
166
|
type: "coder" | "reviewer" | "tester" | "planner" | "researcher" | "security-architect" | "security-auditor" | "memory-specialist" | "swarm-specialist" | "integration-architect" | "performance-engineer" | "core-architect" | "test-architect" | "queen-coordinator" | "project-coordinator";
|
|
167
|
+
id?: string | undefined;
|
|
167
168
|
config?: Record<string, unknown> | undefined;
|
|
168
169
|
timeout?: number | undefined;
|
|
169
|
-
id?: string | undefined;
|
|
170
170
|
}>;
|
|
171
171
|
/**
|
|
172
172
|
* Task input schema
|
|
@@ -181,13 +181,13 @@ export declare const TaskInputSchema: z.ZodObject<{
|
|
|
181
181
|
taskId: string;
|
|
182
182
|
content: string;
|
|
183
183
|
agentType: "coder" | "reviewer" | "tester" | "planner" | "researcher" | "security-architect" | "security-auditor" | "memory-specialist" | "swarm-specialist" | "integration-architect" | "performance-engineer" | "core-architect" | "test-architect" | "queen-coordinator" | "project-coordinator";
|
|
184
|
-
priority?: "
|
|
184
|
+
priority?: "low" | "medium" | "high" | "critical" | undefined;
|
|
185
185
|
metadata?: Record<string, unknown> | undefined;
|
|
186
186
|
}, {
|
|
187
187
|
taskId: string;
|
|
188
188
|
content: string;
|
|
189
189
|
agentType: "coder" | "reviewer" | "tester" | "planner" | "researcher" | "security-architect" | "security-auditor" | "memory-specialist" | "swarm-specialist" | "integration-architect" | "performance-engineer" | "core-architect" | "test-architect" | "queen-coordinator" | "project-coordinator";
|
|
190
|
-
priority?: "
|
|
190
|
+
priority?: "low" | "medium" | "high" | "critical" | undefined;
|
|
191
191
|
metadata?: Record<string, unknown> | undefined;
|
|
192
192
|
}>;
|
|
193
193
|
/**
|
|
@@ -234,16 +234,16 @@ export declare const ExecutorConfigSchema: z.ZodObject<{
|
|
|
234
234
|
cwd: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>>;
|
|
235
235
|
allowSudo: z.ZodDefault<z.ZodBoolean>;
|
|
236
236
|
}, "strip", z.ZodTypeAny, {
|
|
237
|
-
allowedCommands: string[];
|
|
238
237
|
timeout: number;
|
|
238
|
+
allowedCommands: string[];
|
|
239
239
|
maxBuffer: number;
|
|
240
240
|
allowSudo: boolean;
|
|
241
241
|
blockedPatterns?: string[] | undefined;
|
|
242
242
|
cwd?: string | undefined;
|
|
243
243
|
}, {
|
|
244
244
|
allowedCommands: string[];
|
|
245
|
-
blockedPatterns?: string[] | undefined;
|
|
246
245
|
timeout?: number | undefined;
|
|
246
|
+
blockedPatterns?: string[] | undefined;
|
|
247
247
|
maxBuffer?: number | undefined;
|
|
248
248
|
cwd?: string | undefined;
|
|
249
249
|
allowSudo?: boolean | undefined;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "claude-flow",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.73.0",
|
|
4
4
|
"workspaces": [
|
|
5
5
|
"v3/@claude-flow/codex",
|
|
6
6
|
"v3/@claude-flow/mcp",
|
|
@@ -73,7 +73,7 @@
|
|
|
73
73
|
"@claude-flow/codex": "3.0.6",
|
|
74
74
|
"@claude-flow/mcp": "3.1.6",
|
|
75
75
|
"@claude-flow/neural": "3.0.3",
|
|
76
|
-
"@claude-flow/plugin-agent-federation": "1.0.
|
|
76
|
+
"@claude-flow/plugin-agent-federation": "1.0.7",
|
|
77
77
|
"@claude-flow/security": "3.0.6",
|
|
78
78
|
"@claude-flow/shared": "3.0.7",
|
|
79
79
|
"@electron/asar": "^4.3.1",
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
<!-- Try Ruflo — the 3 badges first-time visitors actually act on -->
|
|
8
8
|
[](https://www.npmjs.com/package/ruflo)
|
|
9
9
|
[](https://opensource.org/licenses/MIT)
|
|
10
|
-
[](https://github.com/ruvnet/ruflo)
|
|
11
11
|
[](https://x.com/rUv)
|
|
12
12
|
|
|
13
13
|
<p align="center">
|
|
@@ -23,42 +23,49 @@
|
|
|
23
23
|
|
|
24
24
|
<a id="start-here"></a>
|
|
25
25
|
|
|
26
|
-
## <img src="docs/assets/readme/icons/terminal.svg" width="32" height="32" alt=""> Get started
|
|
26
|
+
## <img src="docs/assets/readme/icons/terminal.svg" width="32" height="32" alt=""> Get started in one command
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
Run this in your project folder:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
npx ruflo@latest init
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Then open Claude Code in the same folder and give it a real task, for example:
|
|
29
35
|
|
|
30
36
|
```text
|
|
31
|
-
|
|
32
|
-
/plugin install ruflo-core@ruflo
|
|
33
|
-
/plugin install ruflo-console@ruflo
|
|
34
|
-
/plugin install ruflo-mods@ruflo
|
|
35
|
-
/reload-plugins
|
|
36
|
-
/ruflo
|
|
37
|
+
Use a ruflo swarm to review this repo: find the riskiest module, write tests for it, and summarise what you changed.
|
|
37
38
|
```
|
|
38
39
|
|
|
39
|
-
|
|
40
|
+
`init` adds ruflo's agents, hooks, memory and MCP server to the project, and Claude Code picks them up on its next start. Codex and other MCP clients work too: point them at `npx -y ruflo@latest mcp start`.
|
|
40
41
|
|
|
41
|
-
|
|
42
|
+
<p align="center"><img src="docs/assets/ruflo-console-tour.gif" width="720" alt="Looping recording of the ruflo console: overview, swarm view and missions in a sample project"></p>
|
|
42
43
|
|
|
43
|
-
|
|
44
|
+
[First useful task, step by step](docs/ruflo-explained.md) · [User guide](docs/USERGUIDE.md) · [Compare install paths](#quick-start)
|
|
44
45
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
```
|
|
46
|
+
<details>
|
|
47
|
+
<summary><b>Other ways to install</b> (Claude Code plugins only, MCP-only clients, terminal UI)</summary>
|
|
48
48
|
|
|
49
|
-
|
|
49
|
+
**Claude Code plugins only.** This route installs core tools, the visual console and runtime mods, with no files added to your project. It needs Claude Code **2.1.287 or later**. Run inside Claude Code:
|
|
50
50
|
|
|
51
|
-
```
|
|
52
|
-
|
|
51
|
+
```text
|
|
52
|
+
/plugin marketplace add ruvnet/ruflo
|
|
53
|
+
/plugin install ruflo-core@ruflo
|
|
54
|
+
/plugin install ruflo-console@ruflo
|
|
55
|
+
/plugin install ruflo-mods@ruflo
|
|
56
|
+
/reload-plugins
|
|
57
|
+
/ruflo
|
|
53
58
|
```
|
|
54
59
|
|
|
55
|
-
|
|
60
|
+
From a terminal, on Claude Code 2.1.292 or later: `claude plugin install ruflo-core@ruflo --marketplace ruvnet/ruflo`. Mods run with your account's permissions, so review their code before installing.
|
|
61
|
+
|
|
62
|
+
**Codex or another MCP client, without project setup.** Configure the **command** `npx` with the **arguments** `["-y", "ruflo@latest", "mcp", "start"]`. To set up a project interactively, run `npx ruflo@latest init wizard`.
|
|
56
63
|
|
|
57
|
-
|
|
64
|
+
**Plain terminal.** The console also runs on its own, without Claude Code: `npx ruflo tui`. Add `--plain` to print one frame for scripts. See the [terminal UI guide](docs/USERGUIDE.md#terminal-ui-optional).
|
|
58
65
|
|
|
59
66
|
<p align="center"><img src="docs/assets/ruflo-tui-compact.svg" width="640" alt="Looping recording of the optional ruflo terminal UI with its pictures: Overview in the Classic BBS look, the Orbital look with its moving globe, and the Swarm graph, in a sample project"></p>
|
|
60
67
|
|
|
61
|
-
|
|
68
|
+
</details>
|
|
62
69
|
|
|
63
70
|
<div align="center">
|
|
64
71
|
|
|
@@ -484,6 +491,7 @@ Four docs for four audiences:
|
|
|
484
491
|
|-----|-----------------|
|
|
485
492
|
| **[Status](docs/STATUS.md)** | See what currently works — capability counts, test baselines, recent fixes, what's next. The *is-it-ready* doc. |
|
|
486
493
|
| **[User Guide](docs/USERGUIDE.md)** | Daily reference — every command, every config flag, every plugin. The *how-do-I* doc. |
|
|
494
|
+
| **[Compare frameworks](docs/compare.md)** | Deciding between Ruflo, Claude Code built-in agents, CrewAI, LangGraph, or AutoGen. The *which-one-for-me* doc. |
|
|
487
495
|
| **[MetaHarness Guide](docs/metaharness-user-guide.md)** | How to grade your agent setup, scan tool configs for security, detect changes between runs, and eject a project into a standalone agent toolkit. The *audit-my-setup* doc. |
|
|
488
496
|
| **[Benchmarks](https://gist.github.com/ruvnet/298f8c668c8859b369f91734a0e9cbbe)** | v3.8.0 SOTA matrix vs LangGraph / AutoGen / CrewAI on darwin-arm64 + linux-x64. ruflo wins cold start, single turn, RSS by 1.3×–1953×. The *is-it-fast* doc. |
|
|
489
497
|
| **[Verification](verification.md)** | Cryptographically prove your installed bytes match the signed witness — `ruflo verify`. The *trust-but-verify* doc. |
|
|
@@ -9,6 +9,7 @@ import { wasmSubcommands } from './agent-wasm.js';
|
|
|
9
9
|
import { agentPublishCommand } from './agntcy/publish.js';
|
|
10
10
|
import * as fs from 'fs';
|
|
11
11
|
import * as path from 'path';
|
|
12
|
+
import { noteFirstAgentRun } from '../funnel/activation.js';
|
|
12
13
|
/**
|
|
13
14
|
* Update swarm-activity.json metrics after agent count changes.
|
|
14
15
|
* The statusline reads this file to display the swarm agent count.
|
|
@@ -172,6 +173,7 @@ const spawnCommand = {
|
|
|
172
173
|
if (ctx.flags.format === 'json') {
|
|
173
174
|
output.printJson(result);
|
|
174
175
|
}
|
|
176
|
+
noteFirstAgentRun('cli'); // activation funnel (opt-in; no-op without telemetry consent)
|
|
175
177
|
return { success: true, data: result };
|
|
176
178
|
}
|
|
177
179
|
catch (error) {
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
* funnel earnings show accrued and paid revenue-share balance
|
|
12
12
|
* funnel unenroll revoke local enrollment (funnel itself stays enabled)
|
|
13
13
|
* funnel id print the pseudonymous funnel ID, if one exists
|
|
14
|
+
* funnel telemetry opt in or out of anonymous usage telemetry (on | off | status)
|
|
14
15
|
*/
|
|
15
16
|
import type { Command } from '../types.js';
|
|
16
17
|
export declare const funnelCommand: Command;
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
* funnel earnings show accrued and paid revenue-share balance
|
|
12
12
|
* funnel unenroll revoke local enrollment (funnel itself stays enabled)
|
|
13
13
|
* funnel id print the pseudonymous funnel ID, if one exists
|
|
14
|
+
* funnel telemetry opt in or out of anonymous usage telemetry (on | off | status)
|
|
14
15
|
*/
|
|
15
16
|
import { execFile } from 'node:child_process';
|
|
16
17
|
import * as fs from 'node:fs';
|
|
@@ -63,11 +64,45 @@ const disableSub = {
|
|
|
63
64
|
action: async () => {
|
|
64
65
|
setUserConfigEnabled(false);
|
|
65
66
|
recordDisclosureDeclined();
|
|
67
|
+
// "All surfaces" includes opt-in event telemetry: revoke it too.
|
|
68
|
+
if (hasConsent('telemetry'))
|
|
69
|
+
recordConsent('telemetry', false, 'cli-funnel-disable');
|
|
66
70
|
deleteFunnelData(); // opt-out deletes the pseudonymous ID + local event queue
|
|
67
|
-
output.printSuccess('Funnel disabled. All promotional surfaces are off
|
|
71
|
+
output.printSuccess('Funnel disabled. All promotional surfaces are off, no funnel.ruv.io requests are made, and local funnel data is deleted.');
|
|
68
72
|
return { success: true };
|
|
69
73
|
},
|
|
70
74
|
};
|
|
75
|
+
// ADR-302 consent domain `telemetry` (ADR-305/309): explicit opt-in to the
|
|
76
|
+
// anonymous funnel event stream. Enrollment never toggles it; only this
|
|
77
|
+
// command does. Off by default.
|
|
78
|
+
const telemetrySub = {
|
|
79
|
+
name: 'telemetry',
|
|
80
|
+
description: 'Opt in or out of anonymous usage telemetry: telemetry on | off | status',
|
|
81
|
+
action: async (ctx) => {
|
|
82
|
+
const verb = String(ctx.args[0] ?? 'status').toLowerCase();
|
|
83
|
+
if (verb === 'on') {
|
|
84
|
+
recordConsent('telemetry', true, 'cli-funnel-telemetry');
|
|
85
|
+
const id = getFunnelId();
|
|
86
|
+
output.printSuccess('Telemetry on. Once per session ruflo sends anonymous funnel events (daily-bucketed, no paths, prompts, code or account data) with a random ID that rotates every 90 days.');
|
|
87
|
+
output.writeln('Turn it off any time with `ruflo funnel telemetry off`; that also deletes the ID and the local event queue.');
|
|
88
|
+
return { success: true, data: { telemetry: true, id } };
|
|
89
|
+
}
|
|
90
|
+
if (verb === 'off') {
|
|
91
|
+
recordConsent('telemetry', false, 'cli-funnel-telemetry');
|
|
92
|
+
deleteFunnelData();
|
|
93
|
+
output.printSuccess('Telemetry off. The pseudonymous ID and the local event queue are deleted.');
|
|
94
|
+
return { success: true, data: { telemetry: false } };
|
|
95
|
+
}
|
|
96
|
+
if (verb !== 'status') {
|
|
97
|
+
output.printError(`Unknown telemetry option "${verb}". Use: on | off | status`);
|
|
98
|
+
return { success: false, exitCode: 1 };
|
|
99
|
+
}
|
|
100
|
+
const on = hasConsent('telemetry');
|
|
101
|
+
output.writeln(`Telemetry: ${on ? 'on (opted in)' : 'off'}`);
|
|
102
|
+
output.writeln('Without opting in, ruflo makes one anonymous request per session to fetch tips (release + OS only); `ruflo funnel disable` stops that too.');
|
|
103
|
+
return { success: true, data: { telemetry: on } };
|
|
104
|
+
},
|
|
105
|
+
};
|
|
71
106
|
const enableSub = {
|
|
72
107
|
name: 'enable',
|
|
73
108
|
description: 'Re-enable funnel surfaces at the user tier (env/enterprise disables still win)',
|
|
@@ -287,7 +322,7 @@ const idSub = {
|
|
|
287
322
|
export const funnelCommand = {
|
|
288
323
|
name: 'funnel',
|
|
289
324
|
description: 'Control the Cognitum lifecycle funnel surfaces (tips, enrollment, notices)',
|
|
290
|
-
subcommands: [statusSub, disableSub, enableSub, acceptSub, openSub, enrollSub, earningsSub, unenrollSub, idSub],
|
|
325
|
+
subcommands: [statusSub, disableSub, enableSub, acceptSub, openSub, enrollSub, earningsSub, unenrollSub, idSub, telemetrySub],
|
|
291
326
|
examples: [
|
|
292
327
|
{ command: 'ruflo funnel status', description: 'Effective state + deciding source' },
|
|
293
328
|
{ command: 'ruflo funnel accept', description: 'Skip the 24h grace so rotation starts now' },
|
|
@@ -4612,8 +4612,22 @@ const refreshFunnelCommand = {
|
|
|
4612
4612
|
],
|
|
4613
4613
|
action: async (ctx) => {
|
|
4614
4614
|
try {
|
|
4615
|
-
const { refreshRemoteMessages } = await import('../funnel/index.js');
|
|
4616
|
-
|
|
4615
|
+
const { refreshRemoteMessages, resolveFunnelEnabled, hasConsent, flushEvents } = await import('../funnel/index.js');
|
|
4616
|
+
// `ruflo funnel disable` (and every other opt-out source) must stop the
|
|
4617
|
+
// network call, not only the promo row (ADR-309 operational telemetry).
|
|
4618
|
+
const decision = resolveFunnelEnabled();
|
|
4619
|
+
const result = decision.enabled
|
|
4620
|
+
? await refreshRemoteMessages()
|
|
4621
|
+
: { refreshed: false, skipped: 'funnel-disabled', decidedBy: decision.decidedBy };
|
|
4622
|
+
// Opt-in event telemetry (ADR-305/309): only with an explicit, current
|
|
4623
|
+
// telemetry consent receipt; flushEvents re-checks consent itself.
|
|
4624
|
+
if (decision.enabled && hasConsent('telemetry')) {
|
|
4625
|
+
const { rufloPackageVersion } = await import('../mcp-protocol.js');
|
|
4626
|
+
// Activation funnel: one "active today" marker per day (7-day retention).
|
|
4627
|
+
const { recordSessionActive } = await import('../funnel/activation.js');
|
|
4628
|
+
recordSessionActive(rufloPackageVersion());
|
|
4629
|
+
result.events = await flushEvents({ release: rufloPackageVersion() });
|
|
4630
|
+
}
|
|
4617
4631
|
if (!ctx.flags.quiet) {
|
|
4618
4632
|
output.writeln(JSON.stringify(result));
|
|
4619
4633
|
}
|