agent-runbook 0.1.2

Generate a local runbook for AI coding agents.
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

use crate::discovery::global::{machine_facts, run_global_checks};
use crate::discovery::local::run_local_checks;
use crate::model::{
    Fact, FactKind, Message, ScanInput, ScanMode, ScanResult, ScanSummary, Scope, Status,
};
use crate::registry::tool_registry;

pub struct ScanCommand {
    pub input: ScanInput,
}

pub fn scan(command: ScanCommand) -> ScanResult {
    let include_global = matches!(command.input.mode, ScanMode::All | ScanMode::Global);
    let include_local = matches!(command.input.mode, ScanMode::All | ScanMode::Local);
    let registry = tool_registry();
    let mut facts = Vec::new();

    if include_global {
        facts.extend(machine_facts());
    }

    for tool in &registry {
        if include_global {
            facts.extend(run_global_checks(tool));
        }

        if include_local {
            facts.extend(run_local_checks(tool, &command.input.cwd));
        }
    }

    let summary = interpret(command.input.mode, facts);
    ScanResult {
        mode: command.input.mode,
        cwd: command.input.cwd,
        minimal: command.input.minimal,
        summary,
    }
}

fn interpret(mode: ScanMode, facts: Vec<Fact>) -> ScanSummary {
    let global_tools: Vec<Fact> = facts
        .iter()
        .filter(|fact| {
            fact.scope == Scope::Global
                && fact.kind == FactKind::Tool
                && fact.status == Status::Found
        })
        .cloned()
        .collect();
    let local_requirements: Vec<Fact> = facts
        .iter()
        .filter(|fact| fact.scope == Scope::Local && fact.kind == FactKind::Requirement)
        .cloned()
        .collect();

    let recommendations = build_recommendations(&facts, &local_requirements);
    let warnings = build_warnings(mode, &global_tools, &local_requirements);

    ScanSummary {
        global_tools,
        local_requirements,
        recommendations,
        warnings,
    }
}

fn build_recommendations(facts: &[Fact], local_requirements: &[Fact]) -> Vec<Message> {
    let mut recommendations = Vec::new();

    if let Some(package_manager) = choose_package_manager(local_requirements) {
        add_message(
            &mut recommendations,
            format!(
                "Use {} for package commands.",
                package_manager.tool_name.as_deref().unwrap_or("unknown")
            ),
            package_manager.evidence.clone(),
        );
    }

    for requirement in local_requirements {
        for guardrail in &requirement.guardrails {
            add_message(
                &mut recommendations,
                guardrail.clone(),
                requirement.evidence.clone(),
            );
        }
    }

    if facts
        .iter()
        .any(|fact| fact.id.as_deref() == Some("secret-like-env"))
    {
        add_message(
            &mut recommendations,
            "Do not print raw environment variables; redact secret-like values.".to_string(),
            Some("secret-like env names detected".to_string()),
        );
    }

    recommendations
}

fn build_warnings(
    mode: ScanMode,
    global_tools: &[Fact],
    local_requirements: &[Fact],
) -> Vec<Message> {
    let mut warnings = Vec::new();

    if mode != ScanMode::Local {
        for requirement in local_requirements {
            let tool_name = requirement.tool_name.as_deref().unwrap_or_default();
            let available = global_tools
                .iter()
                .any(|tool| tool.tool_name.as_deref() == Some(tool_name));
            if requirement.requires_global_command && !available {
                add_message(
                    &mut warnings,
                    format!(
                        "Project expects {}, but no matching command was found globally.",
                        requirement.label
                    ),
                    requirement.evidence.clone(),
                );
            }
        }
    }

    let package_managers: Vec<&str> = local_requirements
        .iter()
        .filter(|requirement| {
            requirement
                .categories
                .iter()
                .any(|category| category == "package-manager")
        })
        .filter_map(|requirement| requirement.tool_name.as_deref())
        .collect();

    if package_managers.contains(&"pnpm") {
        add_message(
            &mut warnings,
            "This project indicates pnpm; avoid npm install unless the user explicitly asks."
                .to_string(),
            Some("pnpm project evidence".to_string()),
        );
    }

    warnings
}

fn choose_package_manager(local_requirements: &[Fact]) -> Option<&Fact> {
    ["pnpm", "yarn", "bun", "npm"].iter().find_map(|tool_name| {
        local_requirements
            .iter()
            .find(|requirement| requirement.tool_name.as_deref() == Some(*tool_name))
    })
}

fn add_message(messages: &mut Vec<Message>, text: String, evidence: Option<String>) {
    if !messages.iter().any(|message| message.text == text) {
        messages.push(Message { text, evidence });
    }
}