Skip to content

Installation Verification

mark7766 edited this page Jul 14, 2026 · 2 revisions

Installation Verification

Confirm your ai-coding-ok installation is complete and correct.


Quick verification

Run the verification script from your project root:

# If you cloned ai-coding-ok to ~/tools/ai-coding-ok
bash ~/tools/ai-coding-ok/scripts/verify.sh .

# Or from the ai-coding-ok repo directory
bash /path/to/ai-coding-ok/scripts/verify.sh

Exit codes

Code Meaning Action
0 ✅ Perfect — all files present, no placeholders Nothing needed
1 ❌ Missing files — some required files are absent Re-run the install script
2 ⚠️ Unfilled placeholders — {{...}} still in files Re-paste customize-prompt.md (Copilot) or re-run install ai-coding-ok (Claude Code)

Manual verification checklist

If you prefer to check manually, verify each of these files exists:

Core files

  • AGENTS.md — starts with <!-- ai-coding-ok: v3.1.0 -->
  • CLAUDE.md — contains @AGENTS.md import

Agent specification

  • .github/agent/system-prompt.md
  • .github/agent/coding-standards.md
  • .github/agent/workflows.md
  • .github/agent/prompt-templates.md

Memory files

  • .github/agent/memory/project-memory.md — your project facts filled in
  • .github/agent/memory/decisions-log.md — at least ADR-001 present
  • .github/agent/memory/task-history.md — at least TASK-001 present

Platform-specific

  • .github/copilot-instructions.md — starts with PDCA enforcement block
  • .cursor/rules/ai-coding-ok.mdc (Cursor only) — has alwaysApply: true
  • .claude/settings.local.json (Claude Code only) — hooks configured

CI & metadata

  • .github/project-metadata.yml
  • .github/PULL_REQUEST_TEMPLATE.md
  • .github/workflows/ci.yml
  • .github/workflows/memory-check.yml

What each file should contain

AGENTS.md

First line should be:

<!-- ai-coding-ok: v3.1.0 -->

The top section should contain the PDCA mandatory instructions (## ⚠️ AI Agent Required Reading).

Should NOT contain any {{...}} placeholders.

project-memory.md

Should contain your actual project name, tech stack, and architecture — not {{project-name}}.

task-history.md

Should contain at least one entry (TASK-001: Install ai-coding-ok).

.claude/settings.local.json (Claude Code)

Should have hooks section with SessionStart, UserPromptSubmit, PreToolUse, and Stop hooks. The {{SOURCE_DIR_PATTERN}} should be replaced with your actual source directories.


Common verification failures

"Missing .claude/settings.local.json"

This is normal if .claude/ didn't exist in your project during install. The hooks are Claude Code-specific; Copilot and Cursor don't need them.

Run install ai-coding-ok again in Claude Code to configure hooks.

"Unfilled placeholders in .github/copilot-instructions.md"

The customization step was incomplete. For Claude Code users, re-run install ai-coding-ok. For Copilot users, re-paste scripts/customize-prompt.md into Copilot Chat.

"settings.json has hooks that conflict with settings.local.json"

This happens when both files exist. Merge the hooks into settings.local.json only and remove hooks from settings.json. See Hooks System for details.

".cursor/rules/ai-coding-ok.mdc missing"

You installed with --copilot but need --cursor. Run:

bash install.sh --cursor

This adds the Cursor rule file alongside the existing installation.


Automated CI verification

The memory-check.yml workflow runs verification on every PR. It checks:

  • Memory files were updated (task-history.md has a new entry)
  • No placeholder leakage
  • Version markers are consistent

See CI Integration for details.


Next steps

Clone this wiki locally