From beec1a429b408c050221b677ee1348b4ab09d2e9 Mon Sep 17 00:00:00 2001 From: Nelson Spence Date: Wed, 11 Mar 2026 23:13:41 -0500 Subject: [PATCH] docs: add help text to CLI options Add help text to CLI options missing descriptions in validate, render, apply, and diff commands. Closes #30 Co-Authored-By: passionworkeer --- src/navi_bootstrap/cli.py | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/src/navi_bootstrap/cli.py b/src/navi_bootstrap/cli.py index 5931aed..bf009c3 100644 --- a/src/navi_bootstrap/cli.py +++ b/src/navi_bootstrap/cli.py @@ -53,8 +53,9 @@ def cli() -> None: "--spec", required=True, type=click.Path(exists=True, path_type=Path), + help="Path to the project spec YAML file", ) -@click.option("--pack", type=str, default=None) +@click.option("--pack", type=str, default=None, help="Name of the template pack to validate") def validate(spec: Path, pack: str | None) -> None: """Validate a spec (and optionally a pack manifest).""" try: @@ -80,14 +81,16 @@ def validate(spec: Path, pack: str | None) -> None: "--spec", required=True, type=click.Path(exists=True, path_type=Path), + help="Path to the project spec YAML file", ) -@click.option("--pack", required=True, type=str) +@click.option("--pack", required=True, type=str, help="Name of the template pack to render") @click.option( "--out", type=click.Path(path_type=Path), default=None, + help="Output directory (defaults to spec name)", ) -@click.option("--dry-run", is_flag=True, default=False) +@click.option("--dry-run", is_flag=True, default=False, help="Preview output without writing files") @click.option("--skip-resolve", is_flag=True, default=False, help="Skip SHA resolution (offline)") @click.option("--trust", is_flag=True, default=False, help="Execute hooks from manifest (unsafe)") def render_cmd( @@ -183,12 +186,13 @@ def render_cmd( "--spec", required=True, type=click.Path(exists=True, path_type=Path), + help="Path to the project spec YAML file", ) -@click.option("--pack", required=True, type=str) +@click.option("--pack", required=True, type=str, help="Name of the template pack to apply") @click.option( "--target", required=True, type=click.Path(exists=True, file_okay=False, path_type=Path) ) -@click.option("--dry-run", is_flag=True, default=False) +@click.option("--dry-run", is_flag=True, default=False, help="Preview output without writing files") @click.option("--skip-resolve", is_flag=True, default=False, help="Skip SHA resolution (offline)") @click.option( "--trust", is_flag=True, default=False, help="Execute hooks/validations from manifest (unsafe)" @@ -291,8 +295,9 @@ def apply( "--spec", required=True, type=click.Path(exists=True, path_type=Path), + help="Path to the project spec YAML file", ) -@click.option("--pack", required=True, type=str) +@click.option("--pack", required=True, type=str, help="Name of the template pack to diff") @click.option( "--target", required=True, type=click.Path(exists=True, file_okay=False, path_type=Path) )