diff --git a/README.md b/README.md index d5f9d32..9087f84 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ This repo is organized similarly to `obra/superpowers` and is designed to scale ai-coding-skills/ ├── README.md ├── docs/ -│ └── install.md +│ └── INSTALL.md ├── skills/ │ ├── _template/ │ │ └── SKILL.md @@ -47,7 +47,7 @@ ai-coding-skills/ | web-automation | claude-code | Playwright + Camoufox browsing/scraping/auth automation | Ready | | web-automation | opencode | Playwright + Camoufox browsing/scraping/auth automation | Ready | -See install instructions: `docs/install.md` +See install instructions: `docs/INSTALL.md` ## Compatibility Policy diff --git a/docs/INSTALL.md b/docs/INSTALL.md new file mode 100644 index 0000000..b632e12 --- /dev/null +++ b/docs/INSTALL.md @@ -0,0 +1,140 @@ +# INSTALL + +Install from this repo similarly to superpowers: clone once, then copy agent-specific skill variants. + +## 1) Clone + +```bash +git clone https://git.fiorinis.com/Home/ai-coding-skills.git +cd ai-coding-skills +``` + +--- + +## 2) Install prerequisite dependency for `create-plan` (Superpowers) + +`create-plan` requires Superpowers planning skills: +- `brainstorming` +- `writing-plans` + +Install Superpowers first (follow upstream instructions): +- https://github.com/obra/superpowers + +### Verify Superpowers dependencies + +Run in your agent's skills root and confirm these exist: + +- `.../skills/brainstorming/SKILL.md` +- `.../skills/writing-plans/SKILL.md` + +If missing, **stop** and return: + +"Missing dependency: Superpowers planning skills are required (`brainstorming`, `writing-plans`). Install from https://github.com/obra/superpowers, then retry." + +--- + +## 3) Install `create-plan` + +### Codex + +```bash +mkdir -p ~/.codex/skills/create-plan +cp -R skills/create-plan/codex/* ~/.codex/skills/create-plan/ +``` + +### Claude Code + +```bash +mkdir -p ~/.claude/skills/create-plan +cp -R skills/create-plan/claude-code/* ~/.claude/skills/create-plan/ +``` + +### OpenCode + +```bash +mkdir -p ~/.opencode/skills/create-plan +cp -R skills/create-plan/opencode/* ~/.opencode/skills/create-plan/ +``` + +### Verify `create-plan` + +```bash +test -f ~/.codex/skills/create-plan/SKILL.md || true +test -f ~/.claude/skills/create-plan/SKILL.md || true +test -f ~/.opencode/skills/create-plan/SKILL.md || true +``` + +--- + +## 4) Install `web-automation` + +### Requirements + +- Node.js 20+ +- pnpm +- Network access to download Camoufox browser artifacts + +### Codex + +```bash +mkdir -p ~/.codex/skills/web-automation +cp -R skills/web-automation/codex/* ~/.codex/skills/web-automation/ +cd ~/.codex/skills/web-automation/scripts +pnpm install +# explicit Playwright install/refresh +pnpm add playwright-core camoufox-js +npx camoufox-js fetch +``` + +### Claude Code + +```bash +mkdir -p ~/.claude/skills/web-automation +cp -R skills/web-automation/claude-code/* ~/.claude/skills/web-automation/ +cd ~/.claude/skills/web-automation/scripts +pnpm install +# explicit Playwright install/refresh +pnpm add playwright-core camoufox-js +npx camoufox-js fetch +``` + +### OpenCode + +```bash +mkdir -p ~/.opencode/skills/web-automation +cp -R skills/web-automation/opencode/* ~/.opencode/skills/web-automation/ +cd ~/.opencode/skills/web-automation/scripts +pnpm install +# explicit Playwright install/refresh +pnpm add playwright-core camoufox-js +npx camoufox-js fetch +``` + +### Verify `web-automation` dependencies + +Run in the installed `scripts/` folder: + +```bash +node -e "require.resolve('playwright-core/package.json');require.resolve('camoufox-js/package.json');console.log('OK: playwright-core + camoufox-js installed')" +node -e "const fs=require('fs');const t=fs.readFileSync('browse.ts','utf8');if(!/camoufox-js/.test(t)){throw new Error('browse.ts is not configured for Camoufox')}console.log('OK: Camoufox integration detected in browse.ts')" +``` + +If checks fail, **stop** and return: + +"Missing dependency/config: web-automation requires `playwright-core` + `camoufox-js` and Camoufox-based scripts. Run setup in this skill, then retry." + +--- + +## 5) Functional verification + +- Ensure `SKILL.md` exists in each installed skill folder. +- Ensure `templates/` exists for `create-plan`. +- Ensure `scripts/` exists for `web-automation`. +- Validate trigger behavior: + - "create a plan for ..." + - "scrape this page ..." + +## Notes + +- `docs/plans` / `docs/plan` can be gitignored by design. +- Plan artifacts are intentionally local. diff --git a/docs/install.md b/docs/install.md deleted file mode 100644 index a442e01..0000000 --- a/docs/install.md +++ /dev/null @@ -1,94 +0,0 @@ -# Installation - -Install from this repo similarly to superpowers: clone once, then copy/symlink agent-specific skills. - -## 1) Clone - -```bash -git clone https://git.fiorinis.com/Home/ai-coding-skills.git -cd ai-coding-skills -``` - -## 2) Install `create-plan` - -### Codex - -```bash -mkdir -p ~/.codex/skills/create-plan -cp -R skills/create-plan/codex/* ~/.codex/skills/create-plan/ -``` - -### Claude Code - -```bash -mkdir -p ~/.claude/skills/create-plan -cp -R skills/create-plan/claude-code/* ~/.claude/skills/create-plan/ -``` - -### OpenCode - -Use your OpenCode skills/plugin path and copy the opencode variant. - -```bash -# Example path (adjust for your environment) -mkdir -p ~/.opencode/skills/create-plan -cp -R skills/create-plan/opencode/* ~/.opencode/skills/create-plan/ -``` - -## 3) Install `web-automation` - -### Codex - -```bash -mkdir -p ~/.codex/skills/web-automation -cp -R skills/web-automation/codex/* ~/.codex/skills/web-automation/ -cd ~/.codex/skills/web-automation/scripts -pnpm install -npx camoufox-js fetch -``` - -### Claude Code - -```bash -mkdir -p ~/.claude/skills/web-automation -cp -R skills/web-automation/claude-code/* ~/.claude/skills/web-automation/ -cd ~/.claude/skills/web-automation/scripts -pnpm install -npx camoufox-js fetch -``` - -### OpenCode - -```bash -mkdir -p ~/.opencode/skills/web-automation -cp -R skills/web-automation/opencode/* ~/.opencode/skills/web-automation/ -cd ~/.opencode/skills/web-automation/scripts -pnpm install -npx camoufox-js fetch -``` - -Requirements for `web-automation`: -- Node.js 20+ -- pnpm -- Browser download/network access for Camoufox -- `playwright-core` and `camoufox-js` installed in the skill scripts workspace - -Dependency verification (run in your installed `scripts/` folder): - -```bash -node -e "require.resolve('playwright-core/package.json');require.resolve('camoufox-js/package.json');console.log('OK: playwright-core + camoufox-js installed')" -node -e "const fs=require('fs');const t=fs.readFileSync('browse.ts','utf8');if(!/camoufox-js/.test(t)){throw new Error('browse.ts is not configured for Camoufox')}console.log('OK: Camoufox integration detected in browse.ts')" -``` - -## 4) Verify - -- Ensure `SKILL.md` exists in the destination folder. -- Ensure `templates/` files (create-plan) or `scripts/` files (web-automation) are present. -- Start a new agent session and ask: - - "create a plan for ..." (create-plan) - - "scrape this page ..." (web-automation) - -## Notes - -- `docs/plans` / `docs/plan` can be gitignored by design. -- Plan artifacts are intentionally local.