site_name: jan
site_description: YAML-defined CLI command trees for agents and humans
site_url: ""
repo_url: https://github.com/patbeagan1/Open-Source-Requests
copyright: MIT License © 2025–2026 patbeagan1
docs_dir: docs
site_dir: site
exclude_docs: |
UPDATES_SUMMARY.md
plugins:
- search
theme:
name: material
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
accent: amber
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: teal
accent: amber
toggle:
icon: material/weather-sunny
name: Switch to light mode
features:
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.top
- navigation.indexes
- search.highlight
- search.suggest
- content.code.copy
- toc.follow
icon:
repo: fontawesome/brands/github
extra_css:
- stylesheets/extra.css
markdown_extensions:
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- tables
- toc:
permalink: true
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
nav:
- Home: index.md
- Start:
- Installation: installation.md
- Quick start: quickstart.md
- Security model: security.md
- Usage:
- Command line: usage/cli.md
- Help and discovery: usage/help.md
- YAML spec:
- Overview: spec/overview.md
- Exec leaves: spec/exec.md
- Include and remote: spec/include.md
- Env, PATH, and requires: spec/env.md
- Typed inputs: spec/inputs.md
- Packages: spec/packages.md
- Time triggers: spec/cron.md
- Command tests: spec/tests.md
- Built-ins:
- jan use: cli/use.md
- jan lab: cli/lab.md
- list, search, show, validate: cli/discovery.md
- jan packages: cli/packages.md
- jan cron: cli/cron.md
- jan runtime: cli/runtime.md
- jan ps: cli/ps.md
- jan test: cli/test.md
- jan audit: cli/audit.md
- jan bundle: cli/bundle.md
- jan alias: cli/alias.md
- jan config: cli/config.md
- Workflows:
- Portable trees: PORTABLE_SCRIPTS.md
- Examples: workflows/examples.md
- Maintainers:
- Overview: maintainers/overview.md
- Architecture: maintainers/architecture.md
- Unifier IPC contract: maintainers/ipc-contract.md
- Releasing: maintainers/releasing.md
- Design notes: GHA_INSPIRED_FEATURES.md
- Troubleshooting: troubleshooting.md