Skip to content

sample-doctor-output.md

Latest commit

 

History

History
103 lines (79 loc) · 4.12 KB

sample-doctor-output.md

File metadata and controls

103 lines (79 loc) · 4.12 KB
Raw

Sample Doctor Output

This page shows the kind of signal code-mower doctor --preflight is meant to produce before you enable reviewer lanes.

--preflight is the friendly first-run preset; doctor --v05 remains equivalent for older scripts.

The exact checks depend on your repository, GitHub auth, provider CLIs, and optional cloud-token setup. This sample is sanitized and intentionally generic.

Human-Readable Shape

$ code-mower doctor --preflight
Code Mower doctor
Status: warn
Config: /path/to/code-mower.example.yml
Provider templates: /path/to/providers.yml
Profile: recommended
Run plan: load-inputs (runtime), select-profile (runtime), runtime (runtime), providers (providers), github (github optional), cloud (cloud optional)
Checks: 18 total, 3 warnings, 0 skipped

Setup
- PASS config.validate: config validates
- PASS provider_templates.load: provider templates load
- PASS doctor.plan: doctor run plan: load-inputs, select-profile, runtime, providers, github, cloud
- PASS profile.select: selected profile recommended: codex, claude_audit
- PASS provider_templates.coverage: provider templates cover selected lanes

Runtime
- PASS runtime.python: Python 3.12 satisfies Code Mower's >=3.12 requirement
- PASS runtime.pytest: pytest import is available for product-side test wrappers
- PASS runtime.github_auth: GitHub CLI auth probe succeeded
- PASS runtime.ripgrep: rg found

Provider lanes (2 warnings)
- WARN env.tokens [codex]: missing token env vars: DISPATCH_TOKEN, GITHUB_TOKEN
  remediation: set DISPATCH_TOKEN, GITHUB_TOKEN in your shell or GitHub secret store before enabling this lane.
- PASS runtime.local_cli [codex]: codex found
- PASS runtime.local_cli.probe [codex]: codex probe succeeded
- WARN env.tokens [claude_audit]: missing token env vars: DISPATCH_TOKEN, GITHUB_TOKEN
  remediation: set DISPATCH_TOKEN, GITHUB_TOKEN in your shell or GitHub secret store before enabling this lane.
- PASS runtime.local_cli [claude_audit]: claude found
- PASS runtime.local_cli.probe [claude_audit]: claude auth smoke probe succeeded

GitHub (1 warning)
- PASS github.cli: gh found for GitHub setup checks
- WARN github.repo.metadata: could not read GitHub repository metadata for owner/repo
  remediation: Verify gh auth can read this repo. Private repos need a token or GitHub App installation with repository access.

Code Mower Cloud
- PASS cloud.token: optional Code Mower Cloud token file is configured

What To Do With It

Treat the doctor output as setup guidance, not as a magical quality score.

  • PASS means the check found enough evidence to continue.
  • WARN means the lane or setup path might work, but you should inspect the remediation before relying on it.
  • FAIL means a required first-run condition is missing.
  • SKIP means the check is not applicable or cannot be probed locally.

--strict turns warnings into a harder gate for CI/bootstrap jobs. For a first local run, start without --strict.

JSON Mode

Use JSON mode for support, automation, or CI:

code-mower doctor --preflight --json > code-mower-doctor.json

The output includes:

  • top-level status and summary counts;
  • the top-level doctor run_plan, so support tooling can tell which optional GitHub/cloud checks ran without parsing human text;
  • one object per check;
  • lane-specific remediation when available;
  • token-safe cloud setup diagnostics; and
  • GitHub/private-repo cost and permission hints.

The JSON output is designed to avoid raw auth output and token values. It can still mention repository slugs, workflow names, provider names, and local setup state, so inspect it before sharing publicly.

Why This Matters

Code Mower's job is not only to run reviewers. It should also tell you when a reviewer lane is expensive, unauthenticated, uncalibrated, too noisy, or dangerous to make merge-gating.

The first successful install should answer:

  • Which reviewer lanes are available on this machine?
  • Which lanes need tokens or GitHub app setup?
  • Which workflows could spend private-repo Actions minutes?
  • Is optional cloud upload configured, and is it still dry-run safe?
  • What should I fix before promoting any lane beyond manual/informational?