Skip to main content

jan_cli/
runner.rs

1use std::ffi::OsString;
2use std::path::PathBuf;
3
4use anyhow::{anyhow, Context, Result};
5use clap::{ArgAction, Parser};
6
7use crate::{
8    builtins, default_db_path, format_help, load_spec, match_commands, resolve_git_branch,
9    resolve_preferred_spec, run_matched, RootSpec, RunContext,
10};
11
12#[derive(Parser, Debug)]
13#[command(name = "jan")]
14#[command(
15    about = "YAML-driven command tree loaded from the preferred directory (`jan use`)",
16    version,
17    disable_help_flag = true
18)]
19pub struct JanCli {
20    /// Print help for the loaded command tree (or framework help if none is configured)
21    #[arg(long, short = 'h', action = ArgAction::SetTrue, global = true)]
22    pub help: bool,
23
24    /// SQLite database path for invocation audit log
25    #[arg(long, value_name = "FILE", env = "JAN_DB", global = true)]
26    pub db: Option<PathBuf>,
27
28    /// Override git branch recorded in the audit log (default: `git rev-parse` or JAN_BRANCH)
29    #[arg(long, global = true)]
30    pub branch: Option<String>,
31
32    /// Do not write to the SQLite audit log
33    #[arg(long, global = true)]
34    pub no_log: bool,
35
36    /// Working directory for subprocesses and git branch detection
37    #[arg(long, global = true, default_value = ".")]
38    pub cwd: PathBuf,
39
40    /// Print how the preferred spec was resolved (stderr)
41    #[arg(short, long, global = true)]
42    pub verbose: bool,
43
44    /// Spec-defined subcommands, then optional passthrough args for `exec.passthrough`
45    #[arg(trailing_var_arg = true, allow_hyphen_values = true)]
46    pub command: Vec<OsString>,
47}
48
49fn framework_builtins_help() -> String {
50    "\
51Built-in commands:
52  use — set, show, or clear the preferred jan directory
53  computer — register, show, or clear the host computer id for `computer:` filtering
54  bundle — pack the preferred YAML tree into a ZIP
55  alias — emit shell aliases for executable leaves
56  config — emit / link / unlink / apply / deps host configuration from the preferred tree
57  list — list script leaves in the preferred tree
58  search — find scripts by name/about/category
59  show — print details for a script leaf
60  validate — structural checks for the preferred tree
61  audit — query the SQLite invocation log
62  cron — start/stop daemon; --list reads the schedule cache (100ms ticks)
63  packages — inspect / prune cached package environments (uv, pnpm, gradle)
64  test — run Given/When/Then shell tests for a command path (and nested)
65  ps — show jan processes and collective CPU usage
66
67Global options:
68  -h, --help       Show this help (lists live subcommands when a preferred dir is set)
69  -V, --version    Print version
70  -v, --verbose    Explain how the preferred directory was resolved
71      --cwd <DIR>  Working directory for subprocesses (default: .)
72      --db <FILE>  SQLite audit log path
73      --branch <B> Override git branch recorded in the audit log
74      --no-log     Do not write to the audit log
75
76Configure a command tree with `jan use <DIR>`, then re-run `jan --help` to list live subcommands.
77"
78    .to_string()
79}
80
81fn print_root_help(spec: Option<&RootSpec>) {
82    match spec {
83        Some(spec) => {
84            print!("{}", format_help(spec, &[], None));
85        }
86        None => {
87            println!("jan — YAML-driven command tree\n");
88            println!("No preferred jan directory is configured yet.\n");
89            println!("  jan use <DIR>     Save a directory containing scripts.spec.yaml");
90            println!("  jan use --show    Show the saved preference\n");
91        }
92    }
93    print!("{}", framework_builtins_help());
94}
95
96pub fn run_jan() -> Result<i32> {
97    let cli = JanCli::parse();
98    let cwd = cli.cwd.canonicalize().unwrap_or_else(|_| cli.cwd.clone());
99
100    // Bootstrap builtins that must work without a loaded YAML tree.
101    if let Some(first) = cli.command.first() {
102        let key = first.to_string_lossy();
103        if builtins::is_pre_spec_builtin(key.as_ref()) {
104            let tail: Vec<_> = cli.command[1..].to_vec();
105            return match key.as_ref() {
106                "use" => builtins::run_use(&tail),
107                "computer" => builtins::run_computer(&tail),
108                "ps" => crate::ps::run_ps(&tail),
109                _ => Ok(0),
110            };
111        }
112    }
113
114    let loaded = match resolve_preferred_spec() {
115        Ok(pair) => Some(pair),
116        Err(e) => {
117            if cli.help || cli.command.is_empty() {
118                print_root_help(None);
119                if cli.verbose {
120                    eprintln!("jan: no preferred spec ({e:#})");
121                }
122                return Ok(0);
123            }
124            return Err(e);
125        }
126    };
127
128    let (spec_path, spec_identity) = loaded.expect("Ok branch always sets Some");
129    let spec = load_spec(&spec_path).with_context(|| format!("load {}", spec_path.display()))?;
130
131    if cli.verbose {
132        eprintln!("jan: cwd={}", cwd.display());
133        eprintln!(
134            "jan: preferred directory: {} / {}",
135            spec_identity.spec_dir, spec_identity.root_yaml
136        );
137    }
138
139    let branch = resolve_git_branch(&cwd, cli.branch.as_deref());
140    let is_test = cli
141        .command
142        .first()
143        .is_some_and(|s| s.to_string_lossy() == "test");
144    let no_log = cli.no_log || is_test || std::env::var_os("JAN_NO_LOG").is_some();
145    let audit_db = cli.db.as_ref().cloned().unwrap_or_else(default_db_path);
146    let db_path = if no_log { None } else { Some(audit_db.clone()) };
147
148    let ctx = RunContext {
149        cwd: &cwd,
150        db_path: db_path.as_deref(),
151        branch,
152        no_log,
153        spec_root: &spec_identity,
154    };
155
156    if cli.command.is_empty() {
157        print_root_help(Some(&spec));
158        return Ok(0);
159    }
160
161    if let Some(first) = cli.command.first() {
162        let key = first.to_string_lossy();
163        if builtins::is_builtin_reserved(key.as_ref()) {
164            let tail: Vec<_> = cli.command[1..].to_vec();
165            return match key.as_ref() {
166                "bundle" => builtins::bundle_spec_zip(&spec_identity, &tail, cli.verbose),
167                "alias" => builtins::emit_shell_aliases(&spec, &tail),
168                "config" => {
169                    let root = PathBuf::from(&spec_identity.spec_dir);
170                    crate::hostconfig::dispatch_config(&spec, &root, &tail)
171                }
172                "use" => builtins::run_use(&tail),
173                "computer" => builtins::run_computer(&tail),
174                "list" | "search" | "show" | "validate" => {
175                    let root = PathBuf::from(&spec_identity.spec_dir);
176                    crate::inspect::dispatch_inspect(key.as_ref(), &tail, &spec, None, Some(&root))
177                }
178                "audit" => crate::inspect::dispatch_inspect(
179                    key.as_ref(),
180                    &tail,
181                    &spec,
182                    Some(&audit_db),
183                    None,
184                ),
185                "cron" => crate::inspect::run_cron(&spec, &tail, &ctx),
186                "packages" => {
187                    let root = PathBuf::from(&spec_identity.spec_dir);
188                    crate::packages::dispatch_packages(&tail, &spec, &root)
189                }
190                "test" => crate::cmdtest::dispatch_test(&tail, &spec, &ctx),
191                "ps" => crate::ps::run_ps(&tail),
192                _ => Ok(0),
193            };
194        }
195    }
196
197    let m = match_commands(&spec, &cli.command);
198
199    if cli.help || m.wants_help {
200        let help = format_help(&spec, &m.chain, m.node);
201        print!("{help}");
202        return Ok(0);
203    }
204
205    if m.trailing.iter().any(|a| a == "--help" || a == "-h") {
206        return Err(anyhow!(
207            "place --help immediately after the subcommand prefix you want help for"
208        ));
209    }
210
211    let node = match m.node {
212        Some(n) => n,
213        None => {
214            let key = cli.command[0].to_string_lossy();
215            return Err(anyhow!("unknown top-level command `{key}`"));
216        }
217    };
218
219    if !m.trailing.is_empty() && !node.is_leaf_exec() {
220        let t = m.trailing[0].to_string_lossy();
221        return Err(anyhow!("unknown subcommand `{t}`"));
222    }
223
224    if node.is_leaf_exec() {
225        return run_matched(&spec, &m.chain, node, &m.trailing, &ctx);
226    }
227
228    let help = format_help(&spec, &m.chain, Some(node));
229    print!("{help}");
230    Ok(0)
231}