-
Notifications
You must be signed in to change notification settings - Fork 2
Installation Verification
Confirm your ai-coding-ok installation is complete and correct.
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| 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 | {{...}} still in files |
Re-paste customize-prompt.md (Copilot) or re-run install ai-coding-ok (Claude Code) |
If you prefer to check manually, verify each of these files exists:
-
AGENTS.md— starts with<!-- ai-coding-ok: v3.1.0 --> -
CLAUDE.md— contains@AGENTS.mdimport
-
.github/agent/system-prompt.md -
.github/agent/coding-standards.md -
.github/agent/workflows.md -
.github/agent/prompt-templates.md
-
.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
-
.github/copilot-instructions.md— starts with PDCA enforcement block -
.cursor/rules/ai-coding-ok.mdc(Cursor only) — hasalwaysApply: true -
.claude/settings.local.json(Claude Code only) — hooks configured
-
.github/project-metadata.yml -
.github/PULL_REQUEST_TEMPLATE.md -
.github/workflows/ci.yml -
.github/workflows/memory-check.yml
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.
Should contain your actual project name, tech stack, and architecture — not {{project-name}}.
Should contain at least one entry (TASK-001: Install ai-coding-ok).
Should have hooks section with SessionStart, UserPromptSubmit, PreToolUse, and Stop hooks. The {{SOURCE_DIR_PATTERN}} should be replaced with your actual source directories.
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.
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.
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.
You installed with --copilot but need --cursor. Run:
bash install.sh --cursorThis adds the Cursor rule file alongside the existing installation.
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.
- PDCA Workflow — understand the loop that runs on every task
- Three-Tier Memory — understand the memory system
- Daily Workflow — what to expect day-to-day
🧠 ai-coding-ok — AI 编程的 PDCA 记忆闭环。
GitHub · Issues · MIT License