Modules§
- remote
- HTTPS fetch with SHA256 verification and TTL-based local caching (wgex-inspired).
Structs§
- Aliases
Spec - Shell aliases declared on a command node (
jan aliasemits them). - Command
Node - Command
Test - One Given/When/Then shell test on a command node.
- Config
Spec - Host configuration declared on a command node (
jan configemit / link / apply / deps). - EnvSpec
- Child-process environment declaration for a command node.
- Exec
Spec - Gradle
Packages - Gradle dependency declaration: pinned Maven coordinates or a locked project,
with an optional minimum JDK (
java:/jdk:). - Host
Computer - Which computer id to use when filtering
computer:lists on commands. - Host
Platform - Which platform string to use when filtering
os:lists on commands. - Include
Link - Retained include identity after load (not authored directly in YAML).
- Local
Include - Local include under the preferred jan directory (YAML subtree or script file).
- Match
Outcome - Metadata
- Packages
Spec - Package-manager deps for a command node (
packages:in YAML). - Pnpm
Packages - pnpm dependency declaration: inline list or a project dir with a lockfile,
with an optional minimum Node version (
node:). - Remote
Include - Root
Spec - RunContext
- Spec
Root Identity - Stable identity for where a YAML spec tree is rooted (directory of linked fragments + entry file).
- User
Config - UvPackages
- uv dependency declaration: inline list, project dir, or requirements file,
with an optional minimum Python version (
python:).
Enums§
- Config
Link Source - One
config.linksource: relative path under the preferred dir, or inline file body. - Config
Shell - One shell fragment: a path under the preferred dir, or inline text.
- Gradle
Deps - Include
Link Kind - Whether an include link pointed at YAML (subtree graft) or a script file (exec leaf).
- Include
Ref - Local path or remote HTTPS include target.
- Pnpm
Deps - UvDeps
Functions§
- default_
db_ path - format_
help - gherkin_
test_ name - True when
nameisgiven_…_when_…_then_…after normalizing spaces/hyphens. - load_
spec - load_
spec_ from_ str - Parse YAML from memory. Use
include_basewhen the document usesinclude:(root or subtree). - load_
user_ config - match_
commands - merge_
specs_ into - Deep-merge
overlay.commandsintobase, letting included YAML fragments add or replace leaves and extend nested groups. - resolve_
git_ branch - resolve_
preferred_ spec - Resolve the preferred jan directory saved by
jan use. - resolve_
spec_ dir_ entry - Resolve a jan directory + entry file name into an absolute spec path and identity.
- run_jan
- run_
matched - validate_
spec - Validate every command in the tree (after merges or programmatic edits).