{
 "schema_version": 1,
 "generated": "2026-10-24",
 "id": "akimiya-z-codex-guard--diagnose-workflow-setup",
 "repo": "Akimiya-z/codex-guard",
 "repo_url": "https://github.com/Akimiya-z/codex-guard",
 "repo_slug": "akimiya-z-codex-guard",
 "title": "Check a Codex Guard install for config errors",
 "page_title": "How to check a Codex Guard install for config errors with Codex Guard",
 "summary": "Run the read-only doctor to find workflow, permission and policy mistakes locally.",
 "who": "A maintainer who just installed or edited Codex Guard policy and is unsure whether the workflow is correct.",
 "problem": "A missing permission or a typo in the policy file can quietly weaken or break the gate.",
 "outcome": "A list of checks for the PR trigger, Action step, permissions, preset, policy YAML and fail-on values, with a clear exit code.",
 "steps": [
  "Run `npx --yes codex-guard doctor` from the repository root.",
  "Run `npx --yes codex-guard doctor --json` if you need machine-readable output.",
  "Fix any configuration errors in the workflow or .github/codex-guard.yml.",
  "Run the doctor again until it exits 0."
 ],
 "agent_prompt": "In the repository at <repo-path>, run `npx --yes codex-guard doctor --json` and save the output. Expected output: JSON describing each check as a pass, warning or error. Verify that the command exit code is 0 or 1 and that any error names the file and key involved.",
 "agents": [
  "any"
 ],
 "difficulty": "Intermediate",
 "time": "15 minutes",
 "basis": "readme",
 "caveat": "The doctor only reads local files, so GitHub branch protection and organization policy still need to be checked in repository settings.",
 "category": "Software and DevOps",
 "tags": [
  "Software and DevOps"
 ],
 "lang": "javascript",
 "requirements": [
  "A GitHub repository with Actions enabled and permission to add a workflow file",
  "Node.js with npx available on your machine",
  "A Git working copy of the repository (the init command runs from its root)",
  "Permission to change branch protection settings if you want the check to block merges"
 ],
 "risk": "none",
 "seen_in_the_wild": false,
 "mentioned_publicly": false,
 "risks": [],
 "best": false,
 "score": 0.8,
 "evidence": [],
 "url": "https://dedupedai.com/use-cases/akimiya-z-codex-guard/diagnose-workflow-setup/",
 "md": "https://dedupedai.com/use-cases/akimiya-z-codex-guard/diagnose-workflow-setup/index.md",
 "disclaimer": "Deduped lists open-source repositories that belong to other people. We do not own, maintain, audit, or vouch for any of them, and a repo appearing here is not an endorsement or a safety check. The use cases, steps, and prompts are written by AI and may be incomplete, outdated, or just wrong. Where a use case is marked \"Seen in the wild\", we link to public posts where someone described something similar, but we have not verified those posts and the use case itself is still our AI's own write-up. Use all of this at your own risk. Only run code, commands, or agents on systems and accounts you are authorized to use, and read the code and every command before you run it, especially anything that touches credentials, files, or the network. Nothing here is professional, security, legal, or financial advice. All trademarks and project names belong to their respective owners, and their use here does not imply affiliation. Content is provided as is, without warranties of any kind. Found a mistake, a safety problem, or something you want removed? Email hello@dedupedai.com and we will look at it promptly.",
 "api": "https://dedupedai.com/api/v1/usecases/akimiya-z-codex-guard--diagnose-workflow-setup.json",
 "api_version": "v1"
}
