Bundle: Improve handling of --format option

Author: amotl

CHANGES.md

@@ -16,6 +16,7 @@
 - Outline: Significantly update `cratedb-outline.yaml`
 - Bundle: Started accepting `--url`/`ABOUT_OUTLINE_URL` option to specify
   alternative input outline file
+- Bundle: Improved handling of `--format` option
 
 ## v0.0.3 - 2025-05-10
 - Outline: Refactored the source of truth for the documentation outline

README.md

@@ -153,7 +153,7 @@ The Markdown file `outline.md` serves as the source for producing the
 `llms.txt` files. Generate multiple `llms.txt` files along with any
 auxiliary output files.
 ```shell
-cratedb-about bundle --format=llms-txt --outdir=./public_html
+cratedb-about bundle --format=llm --outdir=./public_html
 ```
 By default, the bundler will use the built-in `cratedb-outline.yaml` as input file.
 You can select an alternative input file using the `--url` option, or the

src/cratedb_about/bundle/llmstxt.py

@@ -20,7 +20,7 @@ class LllmsTxtBuilder:
     outdir: Path
 
     def run(self):
-        logger.info(f"Bundling llms-txt. Output directory: {self.outdir}")
+        logger.info(f"Creating bundle. Format: llms-txt. Output directory: {self.outdir}")
         self.outdir.mkdir(parents=True, exist_ok=True)
 
         logger.info("Copying source and documentation files")

src/cratedb_about/cli.py

@@ -72,15 +72,20 @@ def outline(
 @cli.command()
 @outline_url_option
 @click.option(
-    "--format", "-f", "format_", type=str, default="llms-txt", help="Output format: Use llms-txt"
+    "--format",
+    "-f",
+    "format_",
+    type=click.Choice(["llm"]),
+    required=True,
+    help="Bundle output format",
 )
 @click.option("--outdir", "-o", envvar="OUTDIR", type=Path, required=True)
 @click.pass_context
 def bundle(ctx: click.Context, url: str, format_: str, outdir: Path) -> None:
     """
     Invoke the bundling. For now: Generate multiple `llms.txt` files.
     """
-    if format_ != "llms-txt":
+    if format_ != "llm":
         raise click.BadOptionUsage("format", f"Invalid output format: {format_}", ctx=ctx)
     builder = LllmsTxtBuilder(outline_url=url, outdir=outdir)
     builder.run()

tests/test_cli.py

@@ -51,14 +51,14 @@ def test_cli_bundle_success(caplog, tmp_path):
     # Invoke command.
     result = runner.invoke(
         cli,
-        args=["bundle"],
+        args=["bundle", "--format", "llm"],
         env={"ABOUT_OUTLINE_URL": TESTING_OUTLINE_FILE, "OUTDIR": str(tmp_path)},
         catch_exceptions=False,
     )
     assert result.exit_code == 0, result.output
 
     # Verify log output.
-    assert "Bundling llms-txt" in caplog.text
+    assert "Creating bundle. Format: llms-txt" in caplog.text
     assert "Ready." in caplog.text
 
     # Verify that the expected output files have been created.
@@ -72,7 +72,7 @@ def test_cli_bundle_without_outdir():
     # Invoke command without OUTDIR environment variable.
     result = runner.invoke(
         cli,
-        args=["bundle"],
+        args=["bundle", "--format", "llm"],
         env={},  # No OUTDIR set
         catch_exceptions=False,
     )
@@ -82,6 +82,22 @@ def test_cli_bundle_without_outdir():
     assert "Error: Missing option '--outdir' / '-o'" in result.output
 
 
+def test_cli_bundle_without_format(tmp_path):
+    runner = CliRunner()
+
+    # Invoke command.
+    result = runner.invoke(
+        cli,
+        args=["bundle"],
+        env={"OUTDIR": str(tmp_path)},
+        catch_exceptions=False,
+    )
+
+    # Verify appropriate error handling.
+    assert result.exit_code != 0, result.output
+    assert "Error: Missing option '--format' / '-f'" in result.output
+
+
 def test_cli_bundle_invalid_format(tmp_path):
     runner = CliRunner()
 
@@ -95,4 +111,4 @@ def test_cli_bundle_invalid_format(tmp_path):
 
     # Verify appropriate error handling.
     assert result.exit_code != 0, result.output
-    assert "Error: Invalid output format: foobar" in result.output
+    assert "Error: Invalid value for '--format' / '-f': 'foobar' is not 'llm'" in result.output