Struct CommandNode 

pub struct CommandNode {

    pub os: Vec<String>,
    pub about: String,
    pub path: Option<String>,
    pub dependencies: Vec<String>,
    pub requires: Vec<String>,
    pub env: EnvSpec,
    pub inputs: BTreeMap<String, InputDef>,
    pub cron: Vec<String>,
    pub packages: PackagesSpec,
    pub tests: BTreeMap<String, CommandTest>,
    pub aliases: AliasesSpec,
    pub commands: BTreeMap<String, CommandNode>,
    pub exec: Option<ExecSpec>,
    pub source: Option<IncludeLink>,
}

Fields

os: Vec<String>

If non-empty, this command and its subtree are only offered on these platforms (linux, macos, windows, …). darwin is accepted as an alias for macos.

about: String

path: Option<String>

Directory prepended to PATH when this script (or a descendant leaf) runs.

dependencies: Vec<String>

Other script names whose path directories are prepended before this one runs.

requires: Vec<String>

External binaries that must be on PATH (e.g. fzf, jq) before the leaf runs.

env: EnvSpec

Public assignments and/or private names required from the host environment.

inputs: BTreeMap<String, InputDef>

Named CLI inputs (--name value) available as ${{ inputs.name }} in env/argv.

cron: Vec<String>

Optional crontab schedule(s). When set, jan cron runs this script’s run leaf whenever the local time matches any expression.

packages: PackagesSpec

Package-manager dependencies (uv now; pnpm reserved).

tests: BTreeMap<String, CommandTest>

Optional Given/When/Then shell tests (jan test <path>).

aliases: AliasesSpec

Extra jan names and/or traditional shell aliases (jan alias).

commands: BTreeMap<String, CommandNode>

exec: Option<ExecSpec>

source: Option<IncludeLink>

Include link this node was loaded from, if any (filled by the loader).

Implementations

impl CommandNode

pub fn is_leaf_exec(&self) -> bool

pub fn validate(&self, path: &str) -> Result<()>

Trait Implementations

impl Clone for CommandNode

fn clone(&self) -> CommandNode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommandNode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CommandNode

fn default() -> CommandNode

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CommandNode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.