codeforerunner 0.4.3__py3-none-any.whl → 0.4.4__py3-none-any.whl

codeforerunner/bundle.py

@@ -5,6 +5,7 @@ from pathlib import Path
 
 
 def _package_prompts() -> Path:
+    """Return the path to the bundled prompts directory inside the package."""
     return Path(__file__).parent / "prompts"
 
 

codeforerunner/check.py

@@ -21,6 +21,8 @@ class Violation:
 
 @dataclass(frozen=True)
 class _Rule:
+    """Drift detection rule: pattern to match, trigger files, and violation message."""
+
     id: str
     pattern: re.Pattern
     triggers: tuple[str, ...]
@@ -124,6 +126,7 @@ _CHANGELOG_FILENAME = "CHANGELOG.md"
 
 
 def _trigger_exists(repo: Path, patterns: tuple[str, ...]) -> bool:
+    """Return True if any pattern matches an existing file in repo."""
     for pat in patterns:
         if "*" in pat:
             parent = repo / Path(pat).parent
@@ -137,6 +140,7 @@ def _trigger_exists(repo: Path, patterns: tuple[str, ...]) -> bool:
 
 
 def _scanned_docs(repo: Path) -> list[Path]:
+    """Collect README.md and all *.md files under docs/ from repo."""
     docs: list[Path] = []
     readme = repo / "README.md"
     if readme.is_file():
@@ -148,6 +152,7 @@ def _scanned_docs(repo: Path) -> list[Path]:
 
 
 def _path_ignored(repo: Path, doc: Path, ignore_patterns: tuple[str, ...]) -> bool:
+    """Return True if doc's repo-relative path matches any ignore pattern."""
     if not ignore_patterns:
         return False
     try:
@@ -158,6 +163,7 @@ def _path_ignored(repo: Path, doc: Path, ignore_patterns: tuple[str, ...]) -> bo
 
 
 def _current_version(repo: Path) -> str | None:
+    """Extract the package version from pyproject.toml, or None if absent/unparseable."""
     pyproject = repo / "pyproject.toml"
     if not pyproject.is_file():
         return None
@@ -175,6 +181,7 @@ def _check_version_drift(
     ignore_patterns: tuple[str, ...],
     enabled: set[str] | None,
 ) -> list[Violation]:
+    """Scan docs for pinned version strings that don't match pyproject.toml."""
     if enabled is not None and "RV1-version-drift" not in enabled:
         return []
     current = _current_version(repo)

codeforerunner/cli.py

@@ -56,6 +56,7 @@ def cmd_doc(args: argparse.Namespace) -> int:
 
 
 def _doc_for(args: argparse.Namespace, task: str) -> int:
+    """Emit bundle for *task* by delegating to cmd_doc with a synthetic Namespace."""
     ns = argparse.Namespace(repo=getattr(args, "repo", None), task=task)
     return cmd_doc(ns)
 
@@ -113,85 +114,17 @@ def cmd_mcp_server(args: argparse.Namespace) -> int:
     return mcp_server.serve(prompts_root)
 
 
-def cmd_generate(args: argparse.Namespace) -> int:
-    """Resolve the bundle for <task> and send it to the configured provider.
-
-    With --prompt-only (or when no provider/key/Ollama is reachable), outputs
-    the assembled prompt bundle to stdout for the calling agent to process.
-    """
-    from codeforerunner import providers as _providers
-    from codeforerunner.config import load_from_repo
-
-    repo_root = Path(args.repo).resolve() if args.repo else Path.cwd()
-    cfg = load_from_repo(repo_root)
-
-    ns = argparse.Namespace(repo=getattr(args, "repo", None), task=args.task)
-
-    # --prompt-only: output the bundle and stop; the calling agent is the model.
-    if getattr(args, "prompt_only", False):
-        return cmd_doc(ns)
-
-    bundle, rc = _get_bundle(ns)
-    if rc != 0:
-        return rc
-
-
-    explicit_provider = args.provider or (cfg.provider if cfg else None)
-    provider_name = explicit_provider or "anthropic"
-    model = args.model or (cfg.model if cfg else None)
-    provider_cls = _providers.get(provider_name)
-    provider = provider_cls()
-    model = model or provider.default_model
-
-    env_var = (cfg.api_key_env.get(provider_name) if cfg else None) or provider.default_env_var
-    api_key = os.environ.get(env_var)
-    if api_key is None and provider_name != "ollama":
-        if explicit_provider is None and _providers.ollama_available():
-            provider_name = "ollama"
-            provider_cls = _providers.get("ollama")
-            provider = provider_cls()
-            if not args.model:
-                model = provider.default_model
-            print("info: no API key; falling back to Ollama (local mode)", file=sys.stderr)
-        elif explicit_provider is None:
-            # Skill-mode auto-detect: no provider configured, no Ollama — output
-            # the prompt bundle for the calling agent to process directly.
-            sys.stdout.write(bundle)
-            if sys.stdout.isatty():
-                print(
-                    "\ninfo: no provider configured and Ollama not running.\n"
-                    "      Prompt bundle written above — paste into your agent,\n"
-                    "      or run: forerunner generate --prompt-only "
-                    f"{args.task}",
-                    file=sys.stderr,
-                )
-            return 0
-        else:
-            print(f"error: missing API key; set ${env_var}", file=sys.stderr)
-            return 3
-
-    if getattr(args, "stream", False):
-        try:
-            for chunk in provider.stream(prompt=bundle, model=model, api_key=api_key):
-                sys.stdout.write(chunk)
-                sys.stdout.flush()
-        except _providers.ProviderError as e:
-            print(f"error: {provider_name} provider failed: {e}", file=sys.stderr)
-            return 4
-        sys.stdout.write("\n")
-        return 0
-
-    try:
-        result = provider.complete(prompt=bundle, model=model, api_key=api_key)
-    except _providers.ProviderError as e:
-        print(f"error: {provider_name} provider failed: {e}", file=sys.stderr)
-        return 4
-
-    sys.stdout.write(result.text.rstrip() + "\n")
-    print(
-        f"# {provider_name} {result.model} {result.usage or ''}".rstrip(),
-        file=sys.stderr,
-    )
+def cmd_refresh(args: argparse.Namespace) -> int:
+    """Emit scan + check + all doc-task bundles to stdout for a full doc refresh."""
+    tasks = ["scan", "check", "readme", "api-docs", "stack-docs",
+             "diagrams", "flows", "version-audit", "audit"]
+    for i, task in enumerate(tasks):
+        ns = argparse.Namespace(repo=getattr(args, "repo", None), task=task)
+        rc = cmd_doc(ns)
+        if rc != 0:
+            return rc
+        if i < len(tasks) - 1:
+            sys.stdout.write("\n---\n\n")
     return 0
 
 
@@ -270,18 +203,8 @@ def build_parser() -> argparse.ArgumentParser:
     )
     s_doctor.set_defaults(func=cmd_doctor)
 
-    s_gen = sub.add_parser("generate", help="resolve bundle for <task> and call the configured provider")
-    s_gen.add_argument("task", help="task basename under prompts/tasks/")
-    s_gen.add_argument("--provider", help="override config provider")
-    s_gen.add_argument("--model", help="override config model")
-    s_gen.add_argument("--stream", action="store_true", help="stream output token-by-token")
-    s_gen.add_argument(
-        "--prompt-only",
-        dest="prompt_only",
-        action="store_true",
-        help="output the assembled prompt bundle to stdout; do not call a model (skill mode)",
-    )
-    s_gen.set_defaults(func=cmd_generate)
+    s_refresh = sub.add_parser("refresh", help="output all doc-refresh bundles in sequence (scan + check + all tasks)")
+    s_refresh.set_defaults(func=cmd_refresh)
 
     from codeforerunner import installer
     installer.add_subparser(sub)

codeforerunner/config.py

@@ -3,13 +3,13 @@
 from __future__ import annotations
 
 from dataclasses import dataclass, field
+from pathlib import Path
 from typing import Any
 
 import yaml
 
 CONFIG_FILENAME = "forerunner.config.yaml"
 
-_KNOWN_PROVIDERS = {"anthropic", "openai", "google", "ollama"}
 _KNOWN_SEVERITIES = {"HIGH", "MEDIUM", "LOW"}
 
 
@@ -40,16 +40,14 @@ class VersionAuditConfig:
 class ForerunnerConfig:
     """Top-level forerunner.config.yaml configuration."""
 
-    provider: str = "anthropic"
-    model: str = "claude-opus-4-7"
     approaching_eol_threshold_months: int = 6
     ignore_patterns: tuple[str, ...] = ()
-    api_key_env: dict[str, str] = field(default_factory=dict)
     check: CheckConfig = field(default_factory=CheckConfig)
     version_audit: VersionAuditConfig = field(default_factory=VersionAuditConfig)
 
 
 def _require_type(value: Any, expected: type, field_name: str) -> Any:
+    """Raise ConfigError if value is not an instance of expected."""
     if not isinstance(value, expected):
         raise ConfigError(
             f"{field_name}: expected {expected.__name__}, got {type(value).__name__}"
@@ -58,7 +56,8 @@ def _require_type(value: Any, expected: type, field_name: str) -> Any:
 
 
 def _coerce_str_tuple(value: Any, field_name: str) -> tuple[str, ...]:
-    if value is None:  # pragma: no cover - callers supply defaults, never pass None
+    """Coerce a list of strings to a tuple, raising ConfigError on bad input."""
+    if value is None:
         return ()
     if not isinstance(value, list):
         raise ConfigError(f"{field_name}: expected list, got {type(value).__name__}")
@@ -70,30 +69,8 @@ def _coerce_str_tuple(value: Any, field_name: str) -> tuple[str, ...]:
     return tuple(out)
 
 
-def _parse_api_key_env(raw: Any) -> dict[str, str]:
-    if raw is None:
-        return {}
-    if not isinstance(raw, dict):
-        raise ConfigError(f"api_key_env: expected dict, got {type(raw).__name__}")
-    out: dict[str, str] = {}
-    for k, v in raw.items():
-        if not isinstance(k, str):  # pragma: no cover - YAML keys are always strings
-            raise ConfigError(
-                f"api_key_env: keys must be strings, got {type(k).__name__}"
-            )
-        if k not in _KNOWN_PROVIDERS:
-            raise ConfigError(
-                f"api_key_env: unknown provider '{k}' (expected one of {sorted(_KNOWN_PROVIDERS)})"
-            )
-        if not isinstance(v, str) or not v:
-            raise ConfigError(
-                f"api_key_env[{k}]: expected non-empty string, got {type(v).__name__}"
-            )
-        out[k] = v
-    return out
-
-
 def _parse_check(raw: Any) -> CheckConfig:
+    """Parse the tasks.check mapping into a CheckConfig."""
     if raw is None:
         return CheckConfig()
     _require_type(raw, dict, "tasks.check")
@@ -120,6 +97,7 @@ def _parse_check(raw: Any) -> CheckConfig:
 
 
 def _to_int(value: Any, field_name: str) -> int:
+    """Convert value to int, raising ConfigError on failure."""
     try:
         return int(value)
     except (TypeError, ValueError) as e:
@@ -127,6 +105,7 @@ def _to_int(value: Any, field_name: str) -> int:
 
 
 def _parse_version_audit(raw: Any) -> VersionAuditConfig:
+    """Parse the tasks.version_audit mapping into a VersionAuditConfig."""
     if raw is None:
         return VersionAuditConfig()
     _require_type(raw, dict, "tasks.version_audit")
@@ -143,24 +122,21 @@ def parse(raw: dict[str, Any] | None) -> ForerunnerConfig:
         return ForerunnerConfig()
     _require_type(raw, dict, "<root>")
 
-    provider = raw.get("provider", "anthropic")
-    _require_type(provider, str, "provider")
-    if provider not in _KNOWN_PROVIDERS:
+    tasks_raw = raw.get("tasks")
+    tasks = tasks_raw if tasks_raw is not None else {}
+    _require_type(tasks, dict, "tasks")
+
+    eol_months = _to_int(
+        raw.get("approaching_eol_threshold_months", 6), "approaching_eol_threshold_months"
+    )
+    if eol_months <= 0:
         raise ConfigError(
-            f"provider: unknown '{provider}' (expected one of {sorted(_KNOWN_PROVIDERS)})"
+            f"approaching_eol_threshold_months: must be a positive integer, got {eol_months}"
         )
 
-    tasks = raw.get("tasks") or {}
-    _require_type(tasks, dict, "tasks")
-
     return ForerunnerConfig(
-        provider=provider,
-        model=_require_type(raw.get("model", "claude-opus-4-7"), str, "model"),
-        approaching_eol_threshold_months=_to_int(
-            raw.get("approaching_eol_threshold_months", 6), "approaching_eol_threshold_months"
-        ),
+        approaching_eol_threshold_months=eol_months,
         ignore_patterns=_coerce_str_tuple(raw.get("ignore_patterns", []), "ignore_patterns"),
-        api_key_env=_parse_api_key_env(raw.get("api_key_env")),
         check=_parse_check(tasks.get("check")),
         version_audit=_parse_version_audit(tasks.get("version_audit")),
     )

codeforerunner/doctor.py

@@ -23,13 +23,6 @@ MARKETPLACE_REL = Path("plugins/codex/marketplace.json")
 MARKER_BEGIN = "<!-- forerunner:begin managed=codeforerunner.skill -->"
 MARKER_END = "<!-- forerunner:end -->"
 
-_DEFAULT_PROVIDER_ENV = {
-    "anthropic": "ANTHROPIC_API_KEY",
-    "openai": "OPENAI_API_KEY",
-    "google": "GOOGLE_API_KEY",
-    "ollama": "OLLAMA_HOST",
-}
-
 
 @dataclass(frozen=True)
 class Finding:
@@ -41,6 +34,7 @@ class Finding:
 
 
 def _installed_skill_destinations() -> list[Path]:
+    """Return default install paths for the codeforerunner skill across supported agents."""
     home = Path(os.path.expanduser("~"))
     return [
         home / ".codex/skills/codeforerunner/SKILL.md",
@@ -49,10 +43,12 @@ def _installed_skill_destinations() -> list[Path]:
 
 
 def _installed_marketplace_destination() -> Path:
+    """Return default install path for the Codex marketplace manifest."""
     return Path(os.path.expanduser("~")) / ".codex/marketplaces/codeforerunner.json"
 
 
 def _load_script_module(repo: Path, relpath: str, module_name: str):
+    """Load a Python script from the repo as a module with a unique name to avoid cache collisions."""
     # L3: unique name prevents stale cached module on repeated calls
     unique_name = f"{module_name}_{uuid.uuid4().hex}"
     script_path = repo / relpath
@@ -66,6 +62,7 @@ def _load_script_module(repo: Path, relpath: str, module_name: str):
 
 
 def _check_skill_body_parity(repo: Path, run_scripts: bool = False) -> list[Finding]:
+    """Verify that all distributed skill copies match the canonical body."""
     if not run_scripts:
         return [
             Finding(
@@ -118,6 +115,7 @@ def _check_skill_body_parity(repo: Path, run_scripts: bool = False) -> list[Find
 
 
 def _check_codex_marketplace(repo: Path, run_scripts: bool = False) -> list[Finding]:
+    """Validate the Codex marketplace manifest using the repo validation script."""
     if not run_scripts:
         return [
             Finding(
@@ -145,6 +143,7 @@ def _check_codex_marketplace(repo: Path, run_scripts: bool = False) -> list[Find
 
 
 def _check_installed_destinations(repo: Path) -> list[Finding]:
+    """Check whether installed skill and marketplace files are present and managed."""
     findings: list[Finding] = []
 
     for dest in _installed_skill_destinations():
@@ -229,6 +228,7 @@ def _check_installed_destinations(repo: Path) -> list[Finding]:
 
 
 def _check_config_loadable(repo: Path) -> list[Finding]:
+    """Try parsing forerunner.config.yaml; report error finding on ConfigError."""
     cfg_path = repo / CONFIG_FILENAME
     if not cfg_path.is_file():
         return [
@@ -245,89 +245,6 @@ def _check_config_loadable(repo: Path) -> list[Finding]:
     return [Finding("ok", "config-loadable", f"{CONFIG_FILENAME} parses cleanly")]
 
 
-def _skill_mode_active() -> bool:
-    """Return True if any installed skill destination has managed markers (agent is the model)."""
-    for dest in _installed_skill_destinations():
-        if dest.exists():
-            try:
-                text = dest.read_text(encoding="utf-8")
-                if MARKER_BEGIN in text and MARKER_END in text:
-                    return True
-            except OSError:
-                pass
-    return False
-
-
-def _check_provider_api_key(repo: Path) -> list[Finding]:
-    from codeforerunner.providers.ollama import is_available as _ollama_available
-
-    cfg_path = repo / CONFIG_FILENAME
-    if not cfg_path.is_file():
-        if _ollama_available():
-            return [
-                Finding(
-                    "ok",
-                    "provider-api-key",
-                    "no config; Ollama running — generate will use local mode automatically",
-                )
-            ]
-        if _skill_mode_active():
-            return [
-                Finding(
-                    "ok",
-                    "provider-api-key",
-                    "no config; skill mode active — the installed agent is the model, no API key needed",
-                )
-            ]
-        return [
-            Finding(
-                "ok",
-                "provider-api-key",
-                f"no {CONFIG_FILENAME}; set an API key in config, start Ollama, or use skill mode (`forerunner generate --prompt-only`)",
-            )
-        ]
-    try:
-        cfg = load_from_repo(repo)
-    except ConfigError:
-        # config-loadable check will surface this; skip here
-        return [
-            Finding(
-                "ok",
-                "provider-api-key",
-                "config unparseable; skipped (see config-loadable)",
-            )
-        ]
-    if cfg is None:  # pragma: no cover - defensive
-        return [
-            Finding(
-                "ok",
-                "provider-api-key",
-                f"no {CONFIG_FILENAME}; provider key not checked",
-            )
-        ]
-    provider = cfg.provider
-    if provider == "ollama":
-        return [
-            Finding(
-                "ok",
-                "provider-api-key",
-                "running in local mode (Ollama; no API key needed)",
-            )
-        ]
-    env_var = cfg.api_key_env.get(provider) or _DEFAULT_PROVIDER_ENV.get(provider, "")
-    if os.environ.get(env_var):
-        return [Finding("ok", "provider-api-key", f"{provider}: {env_var} is set")]
-    # Emit the same warning regardless of skill mode: an explicit provider in config
-    # means the user intends to use that provider, so a missing key is always a real problem.
-    return [
-        Finding(
-            "warn",
-            "provider-api-key",
-            f"{provider}: ${env_var} is not set; `forerunner generate` will refuse to run",
-        )
-    ]
-
-
 _STARTER_CONFIG = """\
 # forerunner.config.yaml — generated by `forerunner doctor --fix`
 # See https://github.com/derek-palmer/codeforerunner for docs.
@@ -359,7 +276,6 @@ def run(repo: Path, run_scripts: bool = False) -> list[Finding]:
     findings.extend(_check_codex_marketplace(repo, run_scripts=run_scripts))
     findings.extend(_check_installed_destinations(repo))
     findings.extend(_check_config_loadable(repo))
-    findings.extend(_check_provider_api_key(repo))
     return findings
 
 

codeforerunner/installer.py

@@ -48,6 +48,7 @@ class Target:
 
 
 def _home() -> Path:
+    """Return the current user's home directory as a Path."""
     return Path(os.path.expanduser("~"))
 
 
@@ -164,10 +165,12 @@ def extract_frontmatter(text: str) -> str:
 
 
 def _hash(s: str) -> str:
+    """Return SHA-256 hex digest of a UTF-8 encoded string."""
     return hashlib.sha256(s.encode("utf-8")).hexdigest()
 
 
 def _hash_bytes(b: bytes) -> str:
+    """Return SHA-256 hex digest of raw bytes."""
     return hashlib.sha256(b).hexdigest()
 
 
@@ -383,6 +386,7 @@ def add_subparser(sub: argparse._SubParsersAction) -> None:
 
 
 def _cli_entry(args: argparse.Namespace) -> int:
+    """Dispatch `forerunner install` subcommand from parsed CLI args."""
     root = Path(args.repo).resolve() if args.repo else Path.cwd()
 
     if getattr(args, "all", False):

codeforerunner/mcp_server.py

@@ -19,6 +19,7 @@ SERVER_VERSION = _pkg_version
 
 
 def _list_tasks(prompts_root: Path) -> list[Path]:
+    """Return sorted list of task *.md paths under prompts_root/tasks/."""
     tasks_dir = prompts_root / "tasks"
     if not tasks_dir.is_dir():
         return []
@@ -37,6 +38,7 @@ def _description_for(task_path: Path) -> str:
 
 
 def _tools(prompts_root: Path) -> list[dict[str, Any]]:
+    """Build MCP tools/list payload from all task files in prompts_root."""
     return [
         {
             "name": p.stem,
@@ -48,10 +50,12 @@ def _tools(prompts_root: Path) -> list[dict[str, Any]]:
 
 
 def _ok(req_id: Any, result: Any) -> dict[str, Any]:
+    """Return a JSON-RPC 2.0 success response."""
     return {"jsonrpc": "2.0", "id": req_id, "result": result}
 
 
 def _err(req_id: Any, code: int, message: str) -> dict[str, Any]:
+    """Return a JSON-RPC 2.0 error response."""
     return {"jsonrpc": "2.0", "id": req_id, "error": {"code": code, "message": message}}
 
 
@@ -59,6 +63,7 @@ SCAN_EXEMPT_TOOLS = frozenset({"init-agent-onboarding", "scan"})
 
 
 def _handle(prompts_root: Path, msg: dict[str, Any], state: dict[str, Any]) -> dict[str, Any] | None:
+    """Dispatch a single JSON-RPC message; return response dict or None for notifications."""
     method = msg.get("method")
     req_id = msg.get("id")
     params = msg.get("params") or {}

codeforerunner/prompts/tasks/refresh.md

@@ -0,0 +1,23 @@
+# Task: Refresh All Documentation
+
+Runs a full documentation refresh cycle: scan, check staleness, then generate or update every stale or missing doc in one pass.
+
+This prompt is the batch form (all bundles concatenated). When running via the `/forerunner-refresh` skill, the agent calls `forerunner doc <task>` for each step individually so it can process each result before moving to the next.
+
+## Steps (execute in order)
+
+1. **Scan** — Execute the scan task bundle. Capture the YAML output. All downstream tasks depend on it.
+2. **Check** — Execute the check task bundle using the scan result. Identify every doc with `STALE` or `MISSING` status.
+3. **Generate / update** — For each stale or missing doc, run the corresponding task bundle in this order:
+   `readme` → `api-docs` → `stack-docs` → `diagrams` → `flows` → `version-audit` → `audit`
+   Skip any task whose check status is `CURRENT`.
+   Note: `changelog` and `review` are on-demand tasks excluded from automated refresh.
+
+## Rules
+
+- The scan result from step 1 is the input to all downstream tasks.
+- The check report from step 2 determines which tasks run.
+- Stop and report if scan fails (non-zero exit or empty output).
+- Write each artifact to its task-defined output path.
+- Append a `## Gaps` section to any doc where evidence is insufficient — never silently omit content.
+- Report a summary of what was updated, skipped, and any gaps found.