okf-cli 0.4.3__tar.gz → 0.4.5__tar.gz

okf_cli-0.4.5/.last-update.json

@@ -0,0 +1 @@
+{"head": "a841967e2873ae08f6af8976cc96d30cd90857c4", "timestamp": "2026-07-13T17:04:00+05:30", "mode": "update"}

{okf_cli-0.4.3 → okf_cli-0.4.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: okf-cli
-Version: 0.4.3
+Version: 0.4.5
 Summary: Open Knowledge Format tooling
 License: MIT License
         

{okf_cli-0.4.3 → okf_cli-0.4.5}/openwiki/architecture.md

@@ -48,7 +48,7 @@ Source: `src/okf/commands/list.py`, `src/okf/commands/show.py`.
 
 - Reserved name handling differs by phase:
   - Bundling phase skips `index.md`, `log.md`, `README.md` (`RESERVED`).
-  - Spec-conformance phase reserves only `index.md`, `log.md` (`SPEC_RESERVED`).
+  - Spec-conformance phase reserves `index.md`, `log.md`, `agents.md` (`SPEC_RESERVED`). `agents.md` is reserved but skipped during conformance checks (not an error).
 - Non-UTF-8 markdown is a conformance error.
 - `type` frontmatter is required and must be non-empty for non-reserved concept files.
 

{okf_cli-0.4.3 → okf_cli-0.4.5}/openwiki/domain-model.md

@@ -34,9 +34,9 @@ Implementation: `src/okf/commands/list.py`, `src/okf/commands/show.py`.
 Two rule sets:
 
 - Bundling input skip set: `index.md`, `log.md`, `README.md` (`RESERVED`)
-- Spec reserved set: `index.md`, `log.md` (`SPEC_RESERVED`)
+- Spec reserved set: `index.md`, `log.md`, `agents.md` (`SPEC_RESERVED`)
 
-Why dual sets: raw input dirs often include README-like repo artifacts; spec-level bundle reading should only reserve spec names.
+Why dual sets: raw input dirs often include README-like repo artifacts; spec-level bundle reading should only reserve spec names plus `agents.md` (generated at bundle root, never a concept).
 
 Implementation: `src/okf/core.py` + command logic.
 
@@ -99,6 +99,7 @@ Source: `src/okf/commands/bundle.py`.
 
 1. non-reserved markdown must have parseable YAML frontmatter;
 1. non-reserved markdown must include non-empty string `type`;
+1. `agents.md` is skipped entirely (no frontmatter/validation);
 1. `index.md` and `log.md` structure rules:
    - non-root `index.md` must not have frontmatter;
    - root `index.md` may have frontmatter only containing `okf_version`;

{okf_cli-0.4.3 → okf_cli-0.4.5}/openwiki/operations.md

@@ -28,8 +28,8 @@ uvx ruff format .
 For bundle smoke:
 
 ```bash
-uv run okf bundle example bundled --default-type reference --force
-uv run okf validate bundled
+uv run okf bundle example --default-type reference --force
+uv run okf validate example_knowledge_base
 ```
 
 ## CI/CD
@@ -48,8 +48,7 @@ No deploy pipeline in repo; CI currently focused on correctness tests.
 ## Repo artifacts and hygiene
 
 - `example/` contains sample source markdown.
-- `bundled-smoke/` contains generated sample output used for smoke/reference.
-- `bundled/` is git-ignored local artifact (`.gitignore`).
+- Default output (`<input>_knowledge_base`) is git-ignored local artifact (`.gitignore`).
 
 When changing command behavior, update sample docs/output only if behavior change is intentional and tested.
 

{okf_cli-0.4.3 → okf_cli-0.4.5}/openwiki/quickstart.md

@@ -11,11 +11,11 @@
 ```bash
 uv sync
 uv run okf --help
-uv run okf bundle example bundled --default-type reference --force
-uv run okf validate bundled
-uv run okf list bundled
-uv run okf show bundled tables/customers
-uv run okf bundle example bundled --default-type reference --force --strict-links
+uv run okf bundle example --default-type reference --force
+uv run okf validate example_knowledge_base
+uv run okf list example_knowledge_base
+uv run okf show example_knowledge_base tables/customers
+uv run okf bundle example --default-type reference --force --strict-links
 ```
 
 Why this sequence:

{okf_cli-0.4.3 → okf_cli-0.4.5}/openwiki/testing.md

@@ -6,6 +6,7 @@
   - parsing helpers (`parse_md`, `parse_frontmatter`)
   - frontmatter generation (`build_frontmatter`)
   - conformance engine (`check_conformance`)
+- End-to-end smoke tests: `tests/e2e/test_e2e.py` (every CLI feature)
 - CLI integration tests:
   - bundling: `tests/cli/test_bundle.py`
   - list: `tests/cli/test_list.py`

{okf_cli-0.4.3 → okf_cli-0.4.5}/openwiki/workflows.md

@@ -19,13 +19,14 @@ Lenient fallback exists for imperfect files, but strict shape gives better metad
 ### 2) Bundle to OKF
 
 ```bash
-uv run okf bundle <input-dir> <output-dir> --default-type reference --force
-uv run okf bundle <input-dir> <output-dir> --default-type reference --force --strict-links
+uv run okf bundle <input-dir> [output-dir] [--default-type <type>] [--force] [--strict-links]
+# output-dir defaults to <input-dir>_knowledge_base
+# --default-type defaults to input directory name
 ```
 
 Important behavior:
 
-- Root-level markdown requires `--default-type`, else skipped with warning.
+- Root-level markdown uses input directory name as type if `--default-type` not specified.
 - Reserved filenames skipped during bundling (`index.md`, `log.md`, `README.md`).
 - `.okfignore` in input root can skip exact bundle-relative paths.
 - `--strict-links` fails if any local `.md` link is missing or points outside bundle.
@@ -91,14 +92,13 @@ Common pitfalls:
 Repo contains:
 
 - source sample: `example/`
-- generated sample: `bundled-smoke/`
 
 Use to verify end-to-end behavior quickly:
 
 ```bash
-uv run okf bundle example bundled-smoke --default-type reference --force
-uv run okf validate bundled-smoke
-uv run okf list bundled-smoke
+uv run okf bundle example --default-type reference --force
+uv run okf validate example_knowledge_base
+uv run okf list example_knowledge_base
 ```
 
-(Generated output directory is ignored by git for default `bundled/`; see `.gitignore`.)
+(Generated output directory is ignored by git for default `example_knowledge_base/`; see `.gitignore`.)

{okf_cli-0.4.3 → okf_cli-0.4.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "okf-cli"
-version = "0.4.3"
+version = "0.4.5"
 description = "Open Knowledge Format tooling"
 readme = "README.md"
 license = { file = "LICENSE" }

{okf_cli-0.4.3 → okf_cli-0.4.5}/src/okf/commands/bundle.py

@@ -78,11 +78,13 @@ def bundle(
     input_dir: str = typer.Argument(
         ..., help="Source directory of plain markdown files"
     ),
-    output_dir: str = typer.Argument(
-        "bundled", help="Output directory for the OKF bundle (default: bundled)"
+    output_dir: str | None = typer.Argument(
+        None,
+        help="Output directory for the OKF bundle "
+        "(default: <input-dir>_knowledge_base)",
     ),
     default_type: str = typer.Option(
-        None, help="Type for root-level files (skip root files if omitted)"
+        None, help="Type for root-level files (default: input directory name)"
     ),
     force: bool = typer.Option(
         False, "--force", "-f", help="Overwrite output directory if it exists"
@@ -97,9 +99,13 @@ def bundle(
 
     Each .md file must start with '# Title' followed by a '>' description block.
     Directory name determines the concept 'type'. Root-level files need --default-type.
-    If output-dir is omitted, defaults to 'bundled'.
+    If output-dir is omitted, defaults to '<input-dir>_knowledge_base'.
     """
     src = Path(input_dir)
+
+    if output_dir is None:
+        output_dir = f"{src.name}_knowledge_base"
+
     dst = Path(output_dir)
 
     if not src.is_dir():
@@ -156,11 +162,7 @@ def bundle(
         typer.echo("No markdown files found (excluding index.md, log.md)", err=True)
         raise typer.Exit(code=1)
 
-    planned_files = [
-        f
-        for f in md_files
-        if not (f.relative_to(src).parent == Path(".") and default_type is None)
-    ]
+    planned_files = md_files
     planned_rels = [f.relative_to(src) for f in planned_files]
     bundle_targets = {rel.as_posix() for rel in planned_rels}
 
@@ -214,13 +216,7 @@ def bundle(
 
         # Determine type
         if rel.parent == Path("."):
-            if default_type is None:
-                typer.echo(
-                    f"Warning: Skipping {rel} — root-level file needs --default-type",
-                    err=True,
-                )
-                continue
-            type_name = default_type
+            type_name = default_type or src.name
         else:
             type_name = rel.parent.name
 
@@ -302,7 +298,15 @@ def bundle(
     # Generate AGENTS.md at bundle root
     (dst / "AGENTS.md").write_text(
         f"# Knowledge Base: {dst.name}\n\n"
-        f"You are in an OKF knowledge base called **{dst.name}**.\n\n"
+        f"You are in an OKF (Open Knowledge Format) knowledge base called "
+        f"**{dst.name}**. OKF is a structured markdown format where each "
+        f"`.md` file is a concept with YAML frontmatter (`type`, `title`, "
+        f"`description`) and cross-links between related concepts.\n\n"
+        "## Instructions\n\n"
+        "- **Answer from this knowledge base only.** Use the concepts and "
+        "links here as your source of truth.\n"
+        "- **If the answer is not in the knowledge base, say so directly.** "
+        "Do not fabricate, guess, or pull from external knowledge.\n\n"
         "## Getting Started\n\n"
         "Read [index.md](index.md) first — it lists all concepts "
         "and subdirectories.\n\n"

{okf_cli-0.4.3 → okf_cli-0.4.5}/tests/cli/test_bundle.py

@@ -82,7 +82,8 @@ def test_bundle_root_file_with_default_type(tmp_path: Path):
     assert "[Standalone](standalone.md)" in root_idx
 
 
-def test_bundle_skip_root_file_without_default(tmp_path: Path, capsys):
+def test_bundle_root_file_uses_input_dir_name_without_default(tmp_path: Path):
+    """Root-level files get type from input directory name when --default-type omitted."""
     src = tmp_path / "notes"
     dst = tmp_path / "bundle"
     src.mkdir()
@@ -97,14 +98,15 @@ def test_bundle_skip_root_file_without_default(tmp_path: Path, capsys):
     result = runner.invoke(app, ["bundle", str(src), str(dst)])
     assert result.exit_code == 0, result.output
 
-    assert not (dst / "standalone.md").exists()
+    assert (dst / "standalone.md").exists()
+    stand = (dst / "standalone.md").read_text()
+    assert 'type: "notes"' in stand
     assert (dst / "tables" / "data.md").exists()
-    assert "Skipping" in result.output
 
-    # Root index should list subdir only (standalone was skipped)
+    # Root index should list subdir + root file
     root_idx = (dst / "index.md").read_text()
     assert "[tables](tables/)" in root_idx
-    assert "[Standalone" not in root_idx
+    assert "[Standalone](standalone.md)" in root_idx
 
 
 def test_bundle_lenient_parse(tmp_path: Path):
@@ -272,7 +274,7 @@ def test_bundle_okfignore_skips_matching_files(tmp_path: Path):
     assert (dst / "tables" / "customers.md").exists()
 
 
-def test_bundle_okfignore_skips_root_file_before_default_type_check(tmp_path: Path):
+def test_bundle_okfignore_skips_root_file(tmp_path: Path):
     src = tmp_path / "notes"
     dst = tmp_path / "bundle"
     src.mkdir()
@@ -287,7 +289,6 @@ def test_bundle_okfignore_skips_root_file_before_default_type_check(tmp_path: Pa
 
     result = runner.invoke(app, ["bundle", str(src), str(dst)])
     assert result.exit_code == 0, result.output
-    assert "root-level file needs --default-type" not in result.output
     assert not (dst / "standalone.md").exists()
     assert (dst / "tables" / "data.md").exists()
 
@@ -452,9 +453,7 @@ def test_bundle_strict_links_passes_with_valid_local_links(tmp_path: Path):
             "tables/orders.md": (
                 "# Orders\n\n> One row.\n\nSee [Customers](./customers.md)."
             ),
-            "tables/customers.md": (
-                "# Customers\n\n> All customers.\n\nBody."
-            ),
+            "tables/customers.md": ("# Customers\n\n> All customers.\n\nBody."),
         },
     )
 

{okf_cli-0.4.3 → okf_cli-0.4.5}/tests/e2e/test_e2e.py

@@ -62,7 +62,8 @@ def test_bundle_default_type_includes_root_files(tmp_path: Path):
     assert 'type: "reference"' in content
 
 
-def test_bundle_skips_root_files_without_default_type(tmp_path: Path):
+def test_bundle_root_files_get_type_from_input_dir(tmp_path: Path):
+    """Root-level files get type from input directory name when --default-type omitted."""
     src = tmp_path / "src"
     dst = tmp_path / "out"
     src.mkdir()
@@ -76,8 +77,9 @@ def test_bundle_skips_root_files_without_default_type(tmp_path: Path):
 
     result = runner.invoke(app, ["bundle", str(src), str(dst)])
     assert result.exit_code == 0, result.output
-    assert not (dst / "domain.md").exists()
-    assert "root-level file needs --default-type" in result.output
+    assert (dst / "domain.md").exists()
+    content = (dst / "domain.md").read_text()
+    assert 'type: "src"' in content
 
 
 def test_bundle_force_overwrites(tmp_path: Path):

{okf_cli-0.4.3 → okf_cli-0.4.5}/uv.lock

@@ -52,7 +52,7 @@ wheels = [
 
 [[package]]
 name = "okf-cli"
-version = "0.4.1"
+version = "0.4.5"
 source = { editable = "." }
 dependencies = [
     { name = "pyyaml" },

okf_cli-0.4.3/.last-update.json

@@ -1,5 +0,0 @@
-{
-  "lastHead": "ddca03b",
-  "lastRun": "2026-07-11",
-  "mode": "update"
-}