Before You Install AkiDevRule
The only hard requirement is Python 3.7+ — the installer, hooks, and every skill script are all Python, no rsync/find/awk dependency. macOS and Linux also need git if you prefer the clone-and-run path over the one-line curl command. install.sh automatically picks the newest Python interpreter on PATH, so a machine with an older python3 still installs cleanly as long as any Python ≥3.7 is present.
Installing on macOS and Linux
curl -fsSL https://raw.githubusercontent.com/lacvietanh/akidevrule/master/install.sh | bash
This is the fastest path with no repo clone needed. If you'd rather read the script first (matching the project's own "inspectable before running" philosophy), clone the repo and run the local copy instead:
git clone https://github.com/lacvietanh/akidevrule.git
cd akidevrule
bash install.sh
Installing on Windows
Windows skips the one-line curl approach — clone the repo and run the Python installer directly (matching the project's "inspectable" philosophy, no blind download-and-run step):
git clone https://github.com/lacvietanh/akidevrule.git
cd akidevrule
.\install.ps1
# or: py -3 install.py
No WSL, Git Bash, or POSIX shell needed on Windows — the installer, hooks, and every supporting skill script are pure Python, verified running on windows-latest in the project's own CI.
What Does the Installer Actually Do?
- Syncs all of
payload/*(the rule corpus) into~/.aki/akidevrule/, auto-removing stale renamed files, touching nothing else in that folder. - Syncs the 10 skills into
~/.claude/skills/— and in parallel into~/.gemini/config/skills/(Antigravity),~/.agents/skills/(Codex CLI),~/.kiro/skills/(Kiro CLI),~/.grok/skills/(Grok CLI) when those CLIs are present on the machine. Synced per skill folder name, never deleting other skills you already had. - Copies the 5 agent files into
~/.claude/agents/one file at a time, preserving your own hand-written agents. - Replaces
~/.claude/CLAUDE.mdwith the packaged guidance (timestamped backup first), appending an@~/.claude/CLAUDE.local.mdimport and your machine's source-repo path. - Creates
~/.claude/CLAUDE.local.mdonly if missing — never overwritten afterward, so per-machine rules live there and survive every reinstall. - Updates
~/.claude/settings.json(backup first): grants read access to~/.aki/akidevrule/**, setsskillOverrides.akirule = "on", registers the session-start update-check hook.
No step requires sudo or admin privileges — everything lives inside your user directory.
Updating AkiDevRule
A SessionStart hook compares the installed CHANGELOG.md against the GitHub copy (at most once per 24h, fail-silent, never blocking a session). When a newer version exists, it only prints the update command, never auto-downloading or auto-installing:
git pull && ./install.sh # Unix
git pull; py -3 install.py # Windows
Uninstalling
Remove the install directory and every synced skill/agent:
rm -rf ~/.aki/akidevrule
rm -rf ~/.claude/skills/{akirule,akiflow,akithink,akihtmlreport,akihelp,akigitcommit,akilint,akiship,aki-article-writer,akidevsync-notes}
rm -f ~/.claude/agents/aki-{hands,judge,conduct,challenger,maker}.md
rm -f ~/.claude/hooks/aki-update-check.py
Then manually remove the AkiDevRule block from ~/.claude/CLAUDE.md and its related entries in settings.json for a full cleanup. Learn what AkiDevRule actually does before installing in What Is AkiDevRule?, or go deeper on the loading mechanism in How AkiDevRule's Rule Corpus and Skills Actually Load.