Move install instructions into per-skill docs and remove single INSTALL doc
This commit is contained in:
@@ -16,7 +16,6 @@ ai-coding-skills/
|
|||||||
├── README.md
|
├── README.md
|
||||||
├── docs/
|
├── docs/
|
||||||
│ ├── README.md
|
│ ├── README.md
|
||||||
│ ├── INSTALL.md
|
|
||||||
│ ├── CREATE-PLAN.md
|
│ ├── CREATE-PLAN.md
|
||||||
│ └── WEB-AUTOMATION.md
|
│ └── WEB-AUTOMATION.md
|
||||||
├── skills/
|
├── skills/
|
||||||
@@ -51,7 +50,8 @@ ai-coding-skills/
|
|||||||
| web-automation | opencode | Playwright + Camoufox browsing/scraping/auth automation | Ready | [WEB-AUTOMATION](docs/WEB-AUTOMATION.md) |
|
| web-automation | opencode | Playwright + Camoufox browsing/scraping/auth automation | Ready | [WEB-AUTOMATION](docs/WEB-AUTOMATION.md) |
|
||||||
|
|
||||||
- Docs index: `docs/README.md`
|
- Docs index: `docs/README.md`
|
||||||
- Install guide: `docs/INSTALL.md`
|
- Create-plan guide: `docs/CREATE-PLAN.md`
|
||||||
|
- Web-automation guide: `docs/WEB-AUTOMATION.md`
|
||||||
|
|
||||||
## Compatibility Policy
|
## Compatibility Policy
|
||||||
|
|
||||||
|
|||||||
@@ -4,9 +4,55 @@
|
|||||||
|
|
||||||
Create structured implementation plans with milestone and story tracking.
|
Create structured implementation plans with milestone and story tracking.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- Superpowers skills installed from: https://github.com/obra/superpowers
|
||||||
|
- Required dependencies:
|
||||||
|
- `brainstorming`
|
||||||
|
- `writing-plans`
|
||||||
|
|
||||||
|
If dependencies are missing, stop and return:
|
||||||
|
|
||||||
|
"Missing dependency: Superpowers planning skills are required (`brainstorming`, `writing-plans`). Install from https://github.com/obra/superpowers, then retry."
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
### 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 Installation
|
||||||
|
|
||||||
|
```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
|
||||||
|
```
|
||||||
|
|
||||||
|
Verify Superpowers dependencies exist in your agent skills root:
|
||||||
|
|
||||||
|
- `.../skills/brainstorming/SKILL.md`
|
||||||
|
- `.../skills/writing-plans/SKILL.md`
|
||||||
|
|
||||||
## Key Behavior
|
## Key Behavior
|
||||||
|
|
||||||
- Requires Superpowers dependencies (`brainstorming`, `writing-plans`).
|
|
||||||
- Creates plans under `ai_plan/YYYY-MM-DD-<short-title>/`.
|
- Creates plans under `ai_plan/YYYY-MM-DD-<short-title>/`.
|
||||||
- Ensures `/ai_plan/` is in `.gitignore`.
|
- Ensures `/ai_plan/` is in `.gitignore`.
|
||||||
- Commits `.gitignore` update locally when added.
|
- Commits `.gitignore` update locally when added.
|
||||||
|
|||||||
140
docs/INSTALL.md
140
docs/INSTALL.md
@@ -1,140 +0,0 @@
|
|||||||
# 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
|
|
||||||
|
|
||||||
- `create-plan` writes plan artifacts under `ai_plan/`.
|
|
||||||
- `ai_plan/` should remain gitignored and local-only.
|
|
||||||
@@ -4,6 +4,14 @@ This directory contains user-facing docs for each skill.
|
|||||||
|
|
||||||
## Index
|
## Index
|
||||||
|
|
||||||
- [CREATE-PLAN.md](./CREATE-PLAN.md) — Planning workflow, milestones, feedback loop, and `ai_plan/` conventions.
|
- [CREATE-PLAN.md](./CREATE-PLAN.md) — Includes requirements, install, verification, and execution workflow for create-plan.
|
||||||
- [WEB-AUTOMATION.md](./WEB-AUTOMATION.md) — Playwright + Camoufox setup, dependency checks, and usage examples.
|
- [WEB-AUTOMATION.md](./WEB-AUTOMATION.md) — Includes requirements, install, dependency verification, and usage examples for web-automation.
|
||||||
- [INSTALL.md](./INSTALL.md) — Installation guide for all supported agent variants.
|
|
||||||
|
## Repo Setup
|
||||||
|
|
||||||
|
Clone the repo first:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://git.fiorinis.com/Home/ai-coding-skills.git
|
||||||
|
cd ai-coding-skills
|
||||||
|
```
|
||||||
|
|||||||
@@ -10,22 +10,56 @@ Automate browsing and scraping with Playwright + Camoufox.
|
|||||||
- pnpm
|
- pnpm
|
||||||
- `playwright-core`
|
- `playwright-core`
|
||||||
- `camoufox-js`
|
- `camoufox-js`
|
||||||
|
- Network access to download Camoufox browser artifacts
|
||||||
|
|
||||||
## Setup Summary
|
## Install
|
||||||
|
|
||||||
1. Install skill files for your agent.
|
### Codex
|
||||||
2. `cd .../skills/web-automation/scripts`
|
|
||||||
3. `pnpm install`
|
|
||||||
4. `pnpm add playwright-core camoufox-js`
|
|
||||||
5. `npx camoufox-js fetch`
|
|
||||||
|
|
||||||
## Dependency Checks
|
```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
|
||||||
|
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
|
||||||
|
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
|
||||||
|
pnpm add playwright-core camoufox-js
|
||||||
|
npx camoufox-js fetch
|
||||||
|
```
|
||||||
|
|
||||||
|
## Verify Installation & Dependencies
|
||||||
|
|
||||||
|
Run in the installed `scripts/` folder:
|
||||||
|
|
||||||
```bash
|
```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 "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')"
|
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."
|
||||||
|
|
||||||
## Usage Examples
|
## Usage Examples
|
||||||
|
|
||||||
- Browse: `npx tsx browse.ts --url "https://example.com"`
|
- Browse: `npx tsx browse.ts --url "https://example.com"`
|
||||||
|
|||||||
Reference in New Issue
Block a user