rhei-cli 0.2.0

Command-line driver for the Rhei agent runtime.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
struct NextOutput<'a> {
    as_json: bool,
    peek: bool,
    /// The assignee this invocation wrote, when it claimed the ticket. `None`
    /// under `--peek` and when the ticket was already claimed.
    claimed_as: Option<&'a str>,
    task: &'a rhei_core::ast::Task,
    from_state: &'a str,
    to_state: &'a str,
    personality: Option<&'a str>,
    instructions: &'a str,
    agent_id: Option<&'a str>,
    model_id: Option<&'a str>,
}

/// Print the `next` command output in either human-readable or JSON format.
fn print_next_output(output: NextOutput<'_>) {
    fn child_json(task: &rhei_core::ast::Task) -> serde_json::Value {
        let children: Vec<serde_json::Value> = task.children.iter().map(child_json).collect();
        serde_json::json!({
            "id": task.id.to_string(),
            "kind": task.kind,
            "title": task.title,
            "state": task.state,
            "content": task.content.trim(),
            "children": children,
        })
    }

    if output.as_json {
        let children: Vec<serde_json::Value> =
            output.task.children.iter().map(child_json).collect();

        let mut obj = serde_json::json!({
            "task_id": output.task.id.to_string(),
            "kind": output.task.kind,
            "title": output.task.title,
            "from_state": output.from_state,
            "state": output.to_state,
            "personality": output.personality,
            "instructions": output.instructions,
            "content": output.task.content.trim(),
            "children": children,
        });
        // Present exactly when this invocation took the claim, so a scripted
        // worker can tell a claim from a peek without re-reading the plan.
        // §FS-rhei-next.4
        if let Some(assignee) = output.claimed_as {
            obj["claimed_as"] = serde_json::json!(assignee);
        }
        if let Some(agent) = output.agent_id {
            obj["agent"] = serde_json::json!(agent);
        }
        if let Some(model) = output.model_id {
            obj["model"] = serde_json::json!(model);
        }
        println!("{}", serde_json::to_string_pretty(&obj).expect("JSON serialization"));
    } else {
        let transitioned = output.from_state != output.to_state;
        if output.peek {
            println!(
                "Task {} — current state: '{}' (read-only peek; not advanced)",
                output.task.id, output.to_state
            );
        } else if transitioned {
            println!(
                "Task {} claimed: '{}' -> '{}'",
                output.task.id, output.from_state, output.to_state
            );
        } else if let Some(assignee) = output.claimed_as {
            // A claim that does not move the ticket is still a claim, and
            // it still wrote the `**Assignee:**` that stops a second worker.
            // §FS-rhei-next.4: claim mode reports the claim it took.
            println!(
                "Task {} claimed by {} (stays in '{}')",
                output.task.id, assignee, output.to_state
            );
        } else {
            println!("Task {} (already in '{}')", output.task.id, output.to_state);
        }
        if output.agent_id.is_some() || output.model_id.is_some() {
            let agent_str = output.agent_id.unwrap_or("none");
            let model_str = output.model_id.unwrap_or("default");
            println!("Agent: {}  |  Model: {}", agent_str, model_str);
        }
        if let Some(personality) = output.personality {
            println!();
            println!("Personality: {}", personality);
        }
        println!();
        println!("## Task {}: {}", output.task.id, output.task.title);
        if !output.task.content.trim().is_empty() {
            println!();
            println!("{}", output.task.content.trim());
        }
        if !output.task.children.is_empty() {
            println!();
            for child in &output.task.children {
                println!(
                    "  - {} {}: {} [{}]",
                    title_case_kind(&child.kind),
                    child.id,
                    child.title,
                    child.state
                );
                if !child.content.trim().is_empty() {
                    for line in child.content.trim().lines() {
                        println!("    {}", line);
                    }
                }
            }
        }
        if !output.instructions.is_empty() {
            println!();
            println!("--- Instructions ({}) ---", output.to_state);
            println!("{}", output.instructions);
        }
    }
}

/// Execute the `render` subcommand for the selected output format.
#[allow(clippy::too_many_arguments)]
fn render_command(
    input: &Path,
    rhei_scope: &[String],
    state_machine_path: Option<&Path>,
    format: RenderFormat,
    pretty: bool,
    no_color: bool,
    no_metadata: bool,
    no_content: bool,
) -> MietteResult<()> {
    let input_buf = normalize_workspace_input(input);
    let input = input_buf.as_path();
    let loaded = load_plan(input)?;
    let scope = resolve_rhei_scope(&loaded, rhei_scope)?;
    let rhei = narrow_rhei_to_scope(&loaded.rhei, &scope);
    // The completion summary needs to know which tickets are done — each
    // judged under its owning rhei's machine. A plan whose machines will not
    // resolve still renders — it just renders without the summary.

    // §DA-per-rhei-state-machines
    let terminal_ids = resolve_state_machines_for_loaded_plan(input, &loaded, state_machine_path)
        .map(|resolved| terminal_ticket_ids(&rhei, &resolved.validator_set()))
        .unwrap_or_default();
    let rendered = render_rhei(
        &rhei,
        terminal_ids,
        loaded.is_panta_project(),
        rhei_machine_attribution(&loaded, &scope),
        format,
        pretty,
        no_color,
        no_metadata,
        no_content,
    )
    .map_err(|err| miette!(help = internal_error_help(), "{err}"))?;
    println!("{rendered}");
    Ok(())
}

/// Each in-scope rhei paired with the machine it actually runs, for the JSON
/// document's `rheis` array. Empty for a plan that is not a merged project.
/// §FS-rhei-render.3.1 §DA-per-rhei-state-machines
fn rhei_machine_attribution(
    loaded: &LoadedPlan,
    scope: &RheiScope,
) -> Vec<rhei_output::RheiMachine> {
    if !loaded.is_panta_project() {
        return Vec::new();
    }
    loaded
        .rhei_ids
        .iter()
        .filter(|id| scope.as_ref().is_none_or(|ids| ids.contains(id.as_str())))
        .map(|id| match loaded.rhei_machines.get(id) {
            Some(declared) => rhei_output::RheiMachine {
                id: id.clone(),
                states: declared.clone(),
                declared: true,
            },
            None => rhei_output::RheiMachine {
                id: id.clone(),
                states: loaded.rhei.states.clone(),
                declared: false,
            },
        })
        .collect()
}

/// Every ticket currently in a terminal state, judged per owning machine, for
/// the progress summary. §DA-per-rhei-state-machines
fn terminal_ticket_ids(
    rhei: &rhei_core::ast::Rhei,
    machines: &rhei_validator::MachineSet,
) -> BTreeSet<String> {
    fn walk(
        tasks: &[rhei_core::ast::Task],
        machines: &rhei_validator::MachineSet,
        out: &mut BTreeSet<String>,
    ) {
        for task in tasks {
            let machine = machines.for_task(&task.id);
            let state = normalized_state_name(task.state.as_str(), machine);
            if machine.states.get(&state).map(|def| def.terminal).unwrap_or(false) {
                out.insert(task.id.to_string());
            }
            walk(&task.children, machines, out);
        }
    }
    let mut out = BTreeSet::new();
    walk(&rhei.tasks, machines, &mut out);
    out
}

/// Drop tickets and content sections outside `scope`, keeping the plan's own
/// title and manifest sections. Priors keep their project-qualified ids: they
/// were resolved against the whole project. §FS-rhei-panta.6
fn narrow_rhei_to_scope(
    rhei: &rhei_core::ast::Rhei,
    scope: &RheiScope,
) -> rhei_core::ast::Rhei {
    if scope.is_none() {
        return rhei.clone();
    }
    let mut narrowed = rhei.clone();
    narrowed.tasks.retain(|task| task_in_rhei_scope(scope, &task.id.to_string()));
    narrowed.content_sections.retain(|section| match section.rhei.as_deref() {
        Some(id) => task_in_rhei_scope(scope, id),
        None => true,
    });
    narrowed
}

/// Render a parsed rhei into the requested output representation.
#[allow(clippy::too_many_arguments)]
fn render_rhei(
    rhei: &rhei_core::ast::Rhei,
    terminal_ids: BTreeSet<String>,
    is_project: bool,
    rhei_machines: Vec<rhei_output::RheiMachine>,
    format: RenderFormat,
    pretty: bool,
    no_color: bool,
    no_metadata: bool,
    no_content: bool,
) -> Result<String> {
    match format {
        RenderFormat::Json => {
            if pretty {
                Ok(rhei_output::to_json_string_pretty_with_rheis(rhei, rhei_machines))
            } else {
                let value = rhei_output::to_json_value_with_rheis(rhei, rhei_machines);
                serde_json::to_string(&value).context("failed to serialize JSON output")
            }
        }
        RenderFormat::Github => Ok(rhei_output::GithubIssuesOutput {
            include_content: !no_content,
            include_metadata: !no_metadata,
        }
        .to_markdown(rhei)),
        RenderFormat::Progress => {
            let color = should_use_color(no_color);
            Ok(rhei_output::ProgressReportOutput {
                color,
                show_dependencies: true,
                terminal_ids,
                is_project,
            }
            .to_string(rhei))
        }
    }
}

/// Decide whether ANSI color should be emitted for progress output.
///
/// Precedence: explicit `--no-color` always wins. Otherwise honour the
/// `NO_COLOR` environment variable (any non-empty value disables color) and
/// fall back to stdout TTY detection.
fn should_use_color(no_color_flag: bool) -> bool {
    use std::io::IsTerminal;
    if no_color_flag {
        return false;
    }
    if std::env::var_os("NO_COLOR").is_some_and(|v| !v.is_empty()) {
        return false;
    }
    std::io::stdout().is_terminal()
}

/// Print versions for the CLI and the crates surfaced by this command.
fn print_versions() {
    println!("rhei-cli {}", env!("CARGO_PKG_VERSION"));
    println!("rhei-core {}", rhei_core::version());
    println!("rhei-validator {}", rhei_validator::version());
    println!("rhei-output {}", rhei_output::version());
}

/// Handler for the `install-skills` subcommand.
///
/// Resolves the agent list (expanding `All`), iterates over each agent,
/// and calls the appropriate install/uninstall handler.
fn install_skills_command(
    agent: Agent,
    local: bool,
    link: bool,
    uninstall: bool,
    dry_run: bool,
    skills: &[String],
) -> MietteResult<()> {
    let agents = expand_agent_list(agent);
    let mut installed_count = 0u32;

    let project_root = if local { Some(find_project_root()?) } else { None };

    // Resolve all skill sources up front. `resolved` owns any extraction of the
    // embedded skills, so it has to outlive every install below.
    let resolved =
        if uninstall { None } else { Some(resolve_skill_sources(skills, link)?) };
    let skill_sources: &[(String, PathBuf)] =
        resolved.as_ref().map(|r| r.sources.as_slice()).unwrap_or(&[]);

    for ag in &agents {
        let label = agent_label(ag);
        let mode_suffix = if local { " (local)" } else { "" };
        println!("\n{}{}:", label, mode_suffix);

        let result = if uninstall {
            uninstall_agent(ag, local, dry_run, skills, project_root.as_deref())
        } else {
            install_agent(ag, local, link, dry_run, skill_sources, project_root.as_deref())
        };

        match result {
            Ok(()) => installed_count += 1,
            Err(e) => eprintln!("  error: {e}"),
        }
    }

    let action = if uninstall { "Uninstalled" } else { "Installed" };
    let scope = if local { " locally" } else { "" };
    println!(
        "\n{} rhei skills{} for {} agent{}.",
        action,
        scope,
        installed_count,
        if installed_count == 1 { "" } else { "s" }
    );
    // The default fans out across every supported agent, which writes config
    // for tools the user may not have. Name the narrower form once. §FS-rhei-install-skills.1
    if agent == Agent::All && installed_count > 1 && !uninstall {
        println!(
            "That was every supported agent (the `--agent` default). Use `--agent <name>` \
             to write only the one you use, or `--uninstall` to remove these again."
        );
    }

    Ok(())
}

/// Expand the `All` agent variant into the full list of concrete agents.
fn expand_agent_list(agent: Agent) -> Vec<Agent> {
    if agent == Agent::All {
        vec![
            Agent::ClaudeCode,
            Agent::Cursor,
            Agent::Windsurf,
            Agent::Copilot,
            Agent::Kilocode,
            Agent::Pi,
            Agent::Codex,
            Agent::Antigravity,
        ]
    } else {
        vec![agent]
    }
}

/// Human-readable label for an agent.
fn agent_label(agent: &Agent) -> &'static str {
    match agent {
        Agent::ClaudeCode => "claude-code",
        Agent::Cursor => "cursor",
        Agent::Windsurf => "windsurf",
        Agent::Copilot => "copilot",
        Agent::Kilocode => "kilocode",
        Agent::Pi => "pi",
        Agent::Codex => "codex",
        Agent::Antigravity => "antigravity",
        Agent::All => "all",
    }
}

/// Home directory helper.
fn home_dir() -> MietteResult<PathBuf> {
    std::env::var("HOME")
        .map(PathBuf::from)
        .map_err(|_| miette!(
            help = "rhei writes user-level files under $HOME. Set HOME, or install into the project with --local.",
            "HOME environment variable not set"
        ))
}

/// Install skills for a single agent.
fn install_agent(
    agent: &Agent,
    local: bool,
    link: bool,
    dry_run: bool,
    skill_sources: &[(String, PathBuf)],
    project_root: Option<&Path>,
) -> MietteResult<()> {
    match agent {
        Agent::ClaudeCode => install_claude_code(skill_sources, local, link, dry_run, project_root),
        Agent::Cursor => install_cursor(skill_sources, local, link, dry_run, project_root),
        Agent::Windsurf => install_windsurf(skill_sources, local, dry_run, project_root),
        Agent::Copilot => install_copilot(skill_sources, local, dry_run, project_root),
        Agent::Kilocode => {
            install_rules_dir_agent(".kilocode", skill_sources, local, link, dry_run, project_root)
        }
        Agent::Pi => {
            install_rules_dir_agent(".pi", skill_sources, local, link, dry_run, project_root)
        }
        Agent::Codex => install_codex(skill_sources, local, link, dry_run, project_root),
        Agent::Antigravity => install_rules_dir_agent(
            ".antigravity",
            skill_sources,
            local,
            link,
            dry_run,
            project_root,
        ),
        Agent::All => Ok(()), // handled by expand_agent_list
    }
}

/// Install skills for Claude Code.
fn install_claude_code(
    skill_sources: &[(String, PathBuf)],
    local: bool,
    link: bool,
    dry_run: bool,
    project_root: Option<&Path>,
) -> MietteResult<()> {
    let base = if local {
        require_project_root(project_root)?.join(".claude")
    } else {
        home_dir()?.join(".claude")
    };

    let skills_dir = base.join("skills");

    // Install each skill directory.
    for (name, source) in skill_sources {
        let dest = skills_dir.join(name);
        if link {
            let src =
                if local { relative_path(dest.parent().unwrap(), source) } else { source.clone() };
            link_skill(&src, &dest, dry_run)?;
        } else {
            copy_skill(source, &dest, dry_run)?;
        }
    }

    // Generate and inject registration block into CLAUDE.md.
    let claude_md = base.join("CLAUDE.md");
    let mut block = String::from("# rhei\n");
    for (name, _) in skill_sources {
        let skill_path = if local {
            format!(".claude/skills/{name}/SKILL.md")
        } else {
            format!("~/.claude/skills/{name}/SKILL.md")
        };
        let description = skill_description(name);
        let trigger = format!("/{name}");
        block.push_str(&format!(
            "- **{name}** (`{skill_path}`) — {description}. Trigger: `{trigger}`\n"
        ));
    }
    let trigger_list: Vec<String> =
        skill_sources.iter().map(|(name, _)| format!("`/{name}`")).collect();
    block.push_str(&format!(
        "When the user types {}, invoke the Skill tool with the corresponding skill name before doing anything else.\n",
        trigger_list.join(", ")
    ));

    // Use heading-based injection for Claude Code (not HTML markers).
    inject_claude_md_section(&claude_md, &block, dry_run)?;

    println!("{} — registered {} skills", claude_md.display(), skill_sources.len());

    Ok(())
}

/// Inject or replace a `# rhei` section in a CLAUDE.md file.
fn inject_claude_md_section(file: &Path, content: &str, dry_run: bool) -> MietteResult<()> {
    let existing = if file.exists() {
        fs::read_to_string(file).map_err(|e| file_io_report(file, "failed to read", e))?
    } else {
        String::new()
    };

    // Replace an existing `# rhei` section in place, taking only the block
    // itself: the rest of the file is the user's. §FS-rhei-install-skills.4.5
    let lines: Vec<&str> = existing.lines().collect();
    let mut new_lines: Vec<String> = Vec::new();
    let mut replaced = false;
    let mut index = 0;

    while index < lines.len() {
        if !replaced && (lines[index] == "# rhei" || lines[index] == "## rhei") {
            new_lines.extend(content.lines().map(ToOwned::to_owned));
            replaced = true;
            index = claude_md_block_end(&lines, index);
            continue;
        }
        new_lines.push(lines[index].to_string());
        index += 1;
    }

    if !replaced {
        // Append the section.
        if !new_lines.is_empty() && !new_lines.last().map(|l| l.is_empty()).unwrap_or(true) {
            new_lines.push(String::new());
        }
        for cl in content.lines() {
            new_lines.push(cl.to_string());
        }
    }

    let mut final_content = new_lines.join("\n");
    if !final_content.ends_with('\n') {
        final_content.push('\n');
    }

    if dry_run {
        println!("  [dry-run] would update {}", file.display());
        return Ok(());
    }

    if let Some(parent) = file.parent() {
        fs::create_dir_all(parent)
            .map_err(|e| file_io_report(parent, "failed to create directory", e))?;
    }
    fs::write(file, &final_content).map_err(|e| file_io_report(file, "failed to write", e))?;

    Ok(())
}