Skip to content
mark7766 edited this page Jul 14, 2026 · 2 revisions

FAQ

Frequently asked questions about ai-coding-ok, grouped by topic.


Installation & Compatibility

Q1: Do I need Claude Code Pro to use ai-coding-ok?

No. Skills are a native Claude Code feature available in the free tier. Copilot users only need a Copilot subscription. ai-coding-ok itself is completely free (MIT license).

Q2: Can I use ai-coding-ok with Cursor / Continue / Cline?

Yes, with varying levels of integration:

Tool How PDCA Strength
Cursor .cursor/rules/ai-coding-ok.mdc (alwaysApply) 🛡️🛡️🛡️
Continue Reference AGENTS.md in rules config 🛡️🛡️
Cline Reference AGENTS.md in rules config 🛡️🛡️

The memory files (.github/agent/memory/*.md) are plain Markdown — any AI tool can read them.

Q3: How do I install on Windows?

Use the Python install script:

python install.py --copilot --target C:\your-project

Or use Git Bash to run install.sh.

Q4: My project already has AGENTS.md. Will it be overwritten?

No. The installer detects conflicts and offers three choices:

  1. Overwrite (risky)
  2. Copy only missing files (safe, recommended)
  3. Abort

It never silently overwrites existing files.

Q5: Does ai-coding-ok work with my existing project?

Yes. It adds files to .github/agent/ and creates/updates AGENTS.md and CLAUDE.md. It doesn't modify your source code or build configuration.


Usage

Q6: Does reading memory files every time slow things down?

The three memory files combined are typically <10KB — negligible in the AI's context window. The cost of NOT reading memory (wrong decisions, breaking existing features) is far higher.

Q7: Will task-history.md grow forever?

No. The convention is to keep the last 30 entries. Older entries should be archived to docs/task-history-archive-YYYY-QN.md. The AI's system prompt instructs it to auto-archive.

Q8: Do I need to manually update memory files?

Usually no. The AI updates task-history.md automatically after every task (Act phase). You should:

  • Occasionally review AI-written entries for accuracy
  • Manually write ADRs for major architecture decisions
  • Monthly scan project-memory.md for stale information

Q9: What if the AI forgets to update memory?

In Claude Code, the Stop hook (v3.1.0+) blocks session end if memory wasn't updated. For Copilot/Cursor, the mandatory ## Memory Updates output section (v3.0.1+) ensures the AI can't skip it.

If it still happens, manually remind:

Run the Act phase: update task-history.md with this task's summary.

Q10: Can I use ai-coding-ok with non-English projects?

Yes. ai-coding-ok has full bilingual support (English + Chinese) since v3.0.0. The AI auto-detects your language during install.


Upgrade & Versioning

Q11: How do I upgrade ai-coding-ok?

Claude Code: upgrade ai-coding-ok in any project.

Copilot/Cursor: Paste scripts/upgrade-prompt.md into your AI tool's chat.

The upgrade preserves all your project customizations. See Upgrade ai-coding-ok.

Q12: Will upgrading overwrite my customizations?

No. The upgrade system diffs at the section level and only applies framework changes. Your project name, tech stack, architecture diagrams, custom ADRs, and constraints are all preserved.

Q13: How do I check my installed version?

head -1 AGENTS.md
# → <!-- ai-coding-ok: v3.1.0 -->

Q14: What's the difference between v3.0.0 and v3.1.0?

v3.0.0 introduced plugin packaging and bilingual templates. v3.1.0 added the Five-Layer Defense System with Claude Code hooks — the most significant reliability improvement since v2.0.

See Version Management for the full history.


superpowers Integration

Q15: Do ai-coding-ok and superpowers conflict?

No. They solve different problems:

  • superpowers = deep thinking within a session (brainstorming, research, multi-agent)
  • ai-coding-ok = cross-session memory (remembering context, decisions, task history)

They compose cleanly. See Combo with superpowers.

Q16: Can I use just one of them?

Yes. ai-coding-ok works independently — you lose deep research/brainstorming capabilities. superpowers works independently — you lose cross-session memory.

If you can only learn one, start with ai-coding-ok (the memory problem is more urgent).

Q17: How do they work together technically?

ai-coding-ok v2.0+ has built-in superpowers compatibility:

  1. AGENTS.md hooks into brainstorming's Step 1
  2. Plans generated by superpowers auto-include a memory update task
  3. ai-coding-ok ensures Act runs after superpowers finishes

Contributing

Q18: I modified templates. How do I contribute back?

  1. Fork the ai-coding-ok repo
  2. Edit files in templates/en/ and templates/zh/ (both must be synced)
  3. If behavior changes, also edit skills/ai-coding-ok/SKILL.md
  4. Submit a PR describing what you changed and why

Q19: A template constraint doesn't fit my project type?

Templates are defaults — you're expected to customize them. If the default is genuinely wrong for a common project type, open an issue to discuss adding a variant.

Q20: How do I report a bug?

Open an issue on GitHub. Include:

  • Your ai-coding-ok version (head -1 AGENTS.md)
  • Your AI tool (Claude Code / Copilot / Cursor)
  • What you expected vs what happened
  • Any error messages

Uninstall & Rollback

Q21: How do I uninstall ai-coding-ok?

# Remove installed files
rm AGENTS.md CLAUDE.md
rm -rf .github/copilot-instructions.md .github/project-metadata.yml \
       .github/PULL_REQUEST_TEMPLATE.md .github/ISSUE_TEMPLATE \
       .github/workflows/ci.yml .github/workflows/memory-check.yml \
       .github/agent
rm -rf .cursor/rules/ai-coding-ok.mdc

# If .github/workflows/ and .github/ are now empty, remove them too

Or git reset --hard HEAD~1 if you committed the install and haven't made other changes.

Q22: Can I temporarily disable ai-coding-ok?

Remove the .github/agent/memory/ directory. The rest of the rules (coding standards, workflows) still apply, but the PDCA memory loop won't trigger.

To re-enable: re-install or restore the directory from git.


Security & Privacy

Q23: Does ai-coding-ok send data anywhere?

No. It's entirely local — Markdown files in your project and shell scripts that run locally. No telemetry, no API calls, no external services.

Q24: Should I put secrets in memory files?

Never. Memory files are committed to git. Use environment variables or a .env file (gitignored) for secrets.

Q25: Can I use ai-coding-ok in a private/proprietary project?

Yes. MIT license allows commercial use, private repos, and modifications. No attribution required (though appreciated).


Still have questions?

Clone this wiki locally