From 8ea6d08e77c73db93d52ae82fda9d4683877e71e Mon Sep 17 00:00:00 2001 From: Stefano Fiorini Date: Thu, 23 Apr 2026 21:53:27 -0500 Subject: [PATCH] docs: add pi manual install guidance --- README.md | 19 +++++++++++------ docs/ATLASSIAN.md | 24 +++++++++++++++++++++- docs/CREATE-PLAN.md | 42 ++++++++++++++++++++++++++++++++------ docs/DO-TASK.md | 40 ++++++++++++++++++++++++++++++++++++ docs/IMPLEMENT-PLAN.md | 46 +++++++++++++++++++++++++++++++++++------- docs/PI.md | 2 +- docs/README.md | 7 +++++++ docs/WEB-AUTOMATION.md | 25 +++++++++++++++++++++++ 8 files changed, 184 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index f1d822d..fc4da2c 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,17 @@ ai-coding-skills/ ├── README.md ├── docs/ │ ├── README.md +│ ├── INSTALLER.md +│ ├── CODEX.md +│ ├── CLAUDE-CODE.md +│ ├── CURSOR.md +│ ├── OPENCODE.md │ ├── ATLASSIAN.md │ ├── CREATE-PLAN.md │ ├── DO-TASK.md │ ├── IMPLEMENT-PLAN.md │ ├── PI.md +│ ├── PI-COMMON-REVIEWER.md │ ├── PI-RESEARCH.md │ ├── PI-SUPERPOWERS.md │ ├── TELEGRAM-NOTIFICATIONS.md @@ -101,12 +107,10 @@ ai-coding-skills/ | web-automation | opencode | CloakBrowser-backed browsing, scraping, auth, flow automation, and install validation | Ready | [WEB-AUTOMATION](docs/WEB-AUTOMATION.md) | | web-automation | pi | CloakBrowser-backed browsing, scraping, auth, flow automation, and install validation | Ready | [WEB-AUTOMATION](docs/WEB-AUTOMATION.md) | -- Docs index: `docs/README.md` -- Atlassian guide: `docs/ATLASSIAN.md` -- Create-plan guide: `docs/CREATE-PLAN.md` -- Do-task guide: `docs/DO-TASK.md` -- Implement-plan guide: `docs/IMPLEMENT-PLAN.md` -- Web-automation guide: `docs/WEB-AUTOMATION.md` +- Start with the docs index: `docs/README.md` +- Automated install/update/remove wizard: `docs/INSTALLER.md` +- Manual install by client: `docs/CODEX.md`, `docs/CLAUDE-CODE.md`, `docs/CURSOR.md`, `docs/OPENCODE.md`, `docs/PI.md` +- Skill guides: `docs/ATLASSIAN.md`, `docs/CREATE-PLAN.md`, `docs/DO-TASK.md`, `docs/IMPLEMENT-PLAN.md`, `docs/WEB-AUTOMATION.md` ## Compatibility Policy @@ -154,8 +158,11 @@ The repo root now includes a pi package manifest that ships only the pi-specific - `pi-package/skills/*/` for the five packaged Pi skills - `skills/reviewer-runtime/pi/` - `docs/PI*.md` +- `scripts/manage-skills.mjs` and `scripts/manage-skills.sh` - `scripts/sync-pi-package-skills.sh` - `scripts/verify-pi-resources.sh` +- `scripts/verify-pi-workflows.sh` +- `scripts/verify-reviewer-support.sh` Install it from a cloned checkout with the repo-owned one-liner: diff --git a/docs/ATLASSIAN.md b/docs/ATLASSIAN.md index b82b1b4..13a7cbe 100644 --- a/docs/ATLASSIAN.md +++ b/docs/ATLASSIAN.md @@ -2,7 +2,7 @@ ## Purpose -Provide a portable Atlassian Cloud skill for Codex, Claude Code, Cursor Agent, and OpenCode using one shared CLI surface for common Jira and Confluence workflows. +Provide a portable Atlassian Cloud skill for Codex, Claude Code, Cursor Agent, OpenCode, and Pi using one shared CLI surface for common Jira and Confluence workflows. ## Why This Skill Exists @@ -117,6 +117,28 @@ cd ~/.cursor/skills/atlassian/scripts pnpm install ``` +### Pi + +Recommended full Pi package install: + +```bash +./scripts/install-pi-package.sh --global +# or, for project-local Pi package install +./scripts/install-pi-package.sh --local +``` + +Manual single-skill Pi install from the package mirror: + +```bash +./scripts/sync-pi-package-skills.sh +mkdir -p .pi/skills/atlassian +cp -R pi-package/skills/atlassian/* .pi/skills/atlassian/ +cd .pi/skills/atlassian/scripts +pnpm install --frozen-lockfile +``` + +Global manual installs use `~/.pi/agent/skills/atlassian/` instead of `.pi/skills/atlassian/`. + ## Verify Installation Run in the installed `scripts/` folder: diff --git a/docs/CREATE-PLAN.md b/docs/CREATE-PLAN.md index 9d281cd..5077d8e 100644 --- a/docs/CREATE-PLAN.md +++ b/docs/CREATE-PLAN.md @@ -14,10 +14,11 @@ Create structured implementation plans with milestone and story tracking, and op - `~/.agents/skills/superpowers -> ~/.codex/superpowers/skills` - For Cursor, skills must be installed under `.cursor/skills/` (repo-local) or `~/.cursor/skills/` (global) - Shared reviewer runtime must be installed beside agent skills when using reviewer CLIs: - - Codex: `~/.codex/skills/reviewer-runtime/run-review.sh` - - Claude Code: `~/.claude/skills/reviewer-runtime/run-review.sh` - - OpenCode: `~/.config/opencode/skills/reviewer-runtime/run-review.sh` - - Cursor: `.cursor/skills/reviewer-runtime/run-review.sh` or `~/.cursor/skills/reviewer-runtime/run-review.sh` + - Codex: `~/.codex/skills/reviewer-runtime/{run-review.sh,notify-telegram.sh}` + - Claude Code: `~/.claude/skills/reviewer-runtime/{run-review.sh,notify-telegram.sh}` + - OpenCode: `~/.config/opencode/skills/reviewer-runtime/{run-review.sh,notify-telegram.sh}` + - Cursor: `.cursor/skills/reviewer-runtime/{run-review.sh,notify-telegram.sh}` or `~/.cursor/skills/reviewer-runtime/{run-review.sh,notify-telegram.sh}` + - Pi: `.pi/skills/reviewer-runtime/pi/{run-review.sh,notify-telegram.sh}` or `~/.pi/agent/skills/reviewer-runtime/pi/{run-review.sh,notify-telegram.sh}` - Telegram notification setup is documented in [TELEGRAM-NOTIFICATIONS.md](./TELEGRAM-NOTIFICATIONS.md) If dependencies are missing, stop and return: @@ -88,6 +89,31 @@ mkdir -p ~/.cursor/skills/reviewer-runtime cp -R skills/reviewer-runtime/* ~/.cursor/skills/reviewer-runtime/ ``` +### Pi + +Recommended full Pi package install: + +```bash +./scripts/install-pi-package.sh --global +# or, for project-local Pi package install +./scripts/install-pi-package.sh --local +``` + +Manual single-skill Pi install from the package mirror: + +```bash +./scripts/sync-pi-package-skills.sh +mkdir -p .pi/skills/create-plan +cp -R pi-package/skills/create-plan/* .pi/skills/create-plan/ +mkdir -p .pi/skills/reviewer-runtime/pi +cp -R skills/reviewer-runtime/pi/* .pi/skills/reviewer-runtime/pi/ +chmod +x .pi/skills/reviewer-runtime/pi/*.sh +``` + +Global manual installs use `~/.pi/agent/skills/create-plan/` and `~/.pi/agent/skills/reviewer-runtime/pi/` instead of `.pi/skills/...`. + +Pi workflow skills also require Superpowers. See [PI-SUPERPOWERS.md](./PI-SUPERPOWERS.md) and [PI-COMMON-REVIEWER.md](./PI-COMMON-REVIEWER.md). + ## Verify Installation ```bash @@ -95,10 +121,12 @@ test -f ~/.codex/skills/create-plan/SKILL.md || true test -f ~/.claude/skills/create-plan/SKILL.md || true test -f ~/.config/opencode/skills/create-plan/SKILL.md || true test -f .cursor/skills/create-plan/SKILL.md || test -f ~/.cursor/skills/create-plan/SKILL.md || true +test -f .pi/skills/create-plan/SKILL.md || test -f ~/.pi/agent/skills/create-plan/SKILL.md || true test -x ~/.codex/skills/reviewer-runtime/run-review.sh || true test -x ~/.claude/skills/reviewer-runtime/run-review.sh || true test -x ~/.config/opencode/skills/reviewer-runtime/run-review.sh || true test -x .cursor/skills/reviewer-runtime/run-review.sh || test -x ~/.cursor/skills/reviewer-runtime/run-review.sh || true +test -x .pi/skills/reviewer-runtime/pi/run-review.sh || test -x ~/.pi/agent/skills/reviewer-runtime/pi/run-review.sh || true ``` Verify Superpowers dependencies exist in your agent skills root: @@ -111,6 +139,8 @@ Verify Superpowers dependencies exist in your agent skills root: - OpenCode: `~/.config/opencode/skills/superpowers/writing-plans/SKILL.md` - Cursor: `.cursor/skills/superpowers/skills/brainstorming/SKILL.md` or `~/.cursor/skills/superpowers/skills/brainstorming/SKILL.md` - Cursor: `.cursor/skills/superpowers/skills/writing-plans/SKILL.md` or `~/.cursor/skills/superpowers/skills/writing-plans/SKILL.md` +- Pi: `.pi/skills/superpowers/brainstorming/SKILL.md` or `~/.pi/agent/skills/superpowers/brainstorming/SKILL.md` or `~/.agents/skills/superpowers/brainstorming/SKILL.md` +- Pi: `.pi/skills/superpowers/writing-plans/SKILL.md` or `~/.pi/agent/skills/superpowers/writing-plans/SKILL.md` or `~/.agents/skills/superpowers/writing-plans/SKILL.md` ## Key Behavior @@ -135,7 +165,7 @@ Verify Superpowers dependencies exist in your agent skills root: After the plan is created (design + milestones + stories), the skill sends it to a second model for review: -1. **Configure** — user picks a reviewer CLI (`codex`, `claude`, `cursor`), a model, and optional max rounds (default 10), or skips +1. **Configure** — user picks a reviewer CLI (`codex`, `claude`, `cursor`, `pi`), a model, and optional max rounds (default 10), or skips 2. **Prepare** — plan payload and a bash reviewer command script are written to temp files 3. **Run** — the command script is executed through `reviewer-runtime/run-review.sh` when installed 4. **Feedback** — reviewer evaluates correctness, risks, missing steps, alternatives, security, and returns `## Summary`, `## Findings`, and `## Verdict` @@ -191,7 +221,7 @@ ts= level= state= --trust --output-format json` | Yes (`--resume `) | `--mode=ask` | | `pi` | See [PI-COMMON-REVIEWER.md](./PI-COMMON-REVIEWER.md) | No (fresh call each round) | `--tools read,grep,find,ls` | -For all three CLIs, the preferred execution path is: +For all supported reviewer CLIs, the preferred execution path is: 1. write the reviewer command to a bash script 2. run that script through `reviewer-runtime/run-review.sh` diff --git a/docs/DO-TASK.md b/docs/DO-TASK.md index 4be07c8..0d3b8d2 100644 --- a/docs/DO-TASK.md +++ b/docs/DO-TASK.md @@ -25,6 +25,7 @@ Execute a single user-supplied prompt end-to-end with **two reviewer loops** (pl - Claude Code: `~/.claude/skills/reviewer-runtime/{run-review.sh,notify-telegram.sh}` - OpenCode: `~/.config/opencode/skills/reviewer-runtime/{run-review.sh,notify-telegram.sh}` - Cursor: `.cursor/skills/reviewer-runtime/{run-review.sh,notify-telegram.sh}` (repo-local, preferred) or `~/.cursor/skills/reviewer-runtime/{run-review.sh,notify-telegram.sh}` (global fallback) + - Pi: `.pi/skills/reviewer-runtime/pi/{run-review.sh,notify-telegram.sh}` (repo-local) or `~/.pi/agent/skills/reviewer-runtime/pi/{run-review.sh,notify-telegram.sh}` (global) - Variant-specific prerequisites: - **Claude Code:** `claude --version`, explicit `Skill`-tool invocation of sub-skills. - **Codex:** `codex --version`; `~/.agents/skills/superpowers -> ~/.codex/superpowers/skills` symlink present. @@ -38,6 +39,7 @@ Dependency-missing messages are variant-specific: - **Codex:** `Missing dependency: [specific missing item]. Install required Superpowers skills (https://github.com/obra/superpowers) and the reviewer-runtime helper, then retry.` - **Cursor:** `Missing dependency: [specific missing item]. Install Cursor Agent CLI, jq, and Superpowers skills under .cursor/skills/ or ~/.cursor/skills/, then retry.` - **OpenCode:** `Missing dependency: [specific missing item]. Install required OpenCode Superpowers skills (https://github.com/obra/superpowers, OpenCode setup) and the reviewer-runtime helper, then retry.` +- **Pi:** `Missing dependency: [specific missing item]. Install Pi, required Superpowers skills, and the Pi reviewer-runtime helper, then retry.` ### Reviewer CLI Requirements @@ -104,6 +106,31 @@ mkdir -p ~/.cursor/skills/reviewer-runtime cp -R skills/reviewer-runtime/* ~/.cursor/skills/reviewer-runtime/ ``` +### Pi + +Recommended full Pi package install: + +```bash +./scripts/install-pi-package.sh --global +# or, for project-local Pi package install +./scripts/install-pi-package.sh --local +``` + +Manual single-skill Pi install from the package mirror: + +```bash +./scripts/sync-pi-package-skills.sh +mkdir -p .pi/skills/do-task +cp -R pi-package/skills/do-task/* .pi/skills/do-task/ +mkdir -p .pi/skills/reviewer-runtime/pi +cp -R skills/reviewer-runtime/pi/* .pi/skills/reviewer-runtime/pi/ +chmod +x .pi/skills/reviewer-runtime/pi/*.sh +``` + +Global manual installs use `~/.pi/agent/skills/do-task/` and `~/.pi/agent/skills/reviewer-runtime/pi/` instead of `.pi/skills/...`. + +Pi workflow skills also require Superpowers. See [PI-SUPERPOWERS.md](./PI-SUPERPOWERS.md) and [PI-COMMON-REVIEWER.md](./PI-COMMON-REVIEWER.md). + ## Verify Installation Run the per-variant checks for everything the corresponding `SKILL.md` enforces. Each check is structured: (1) CLI binary version, (2) skill file presence, (3) reviewer-runtime + notifier helper presence, (4) Superpowers sub-skill discovery, (5) variant-specific extras. @@ -163,6 +190,19 @@ test -f .cursor/skills/superpowers/skills/verification-before-completion/SKILL.m test -f .cursor/skills/superpowers/skills/finishing-a-development-branch/SKILL.md || test -f ~/.cursor/skills/superpowers/skills/finishing-a-development-branch/SKILL.md ``` +### Pi + +```bash +pi --version +test -f .pi/skills/do-task/SKILL.md || test -f ~/.pi/agent/skills/do-task/SKILL.md +test -x .pi/skills/reviewer-runtime/pi/run-review.sh || test -x ~/.pi/agent/skills/reviewer-runtime/pi/run-review.sh +test -x .pi/skills/reviewer-runtime/pi/notify-telegram.sh || test -x ~/.pi/agent/skills/reviewer-runtime/pi/notify-telegram.sh +test -f .pi/skills/superpowers/brainstorming/SKILL.md || test -f ~/.pi/agent/skills/superpowers/brainstorming/SKILL.md || test -f ~/.agents/skills/superpowers/brainstorming/SKILL.md +test -f .pi/skills/superpowers/test-driven-development/SKILL.md || test -f ~/.pi/agent/skills/superpowers/test-driven-development/SKILL.md || test -f ~/.agents/skills/superpowers/test-driven-development/SKILL.md +test -f .pi/skills/superpowers/verification-before-completion/SKILL.md || test -f ~/.pi/agent/skills/superpowers/verification-before-completion/SKILL.md || test -f ~/.agents/skills/superpowers/verification-before-completion/SKILL.md +test -f .pi/skills/superpowers/finishing-a-development-branch/SKILL.md || test -f ~/.pi/agent/skills/superpowers/finishing-a-development-branch/SKILL.md || test -f ~/.agents/skills/superpowers/finishing-a-development-branch/SKILL.md +``` + ## Key Behavior - Creates one persistent plan artifact at `ai_plan/YYYY-MM-DD-/task-plan.md`. diff --git a/docs/IMPLEMENT-PLAN.md b/docs/IMPLEMENT-PLAN.md index f417fa2..20f8fc1 100644 --- a/docs/IMPLEMENT-PLAN.md +++ b/docs/IMPLEMENT-PLAN.md @@ -21,10 +21,11 @@ Execute an existing plan (created by `create-plan`) in an isolated git worktree, - `~/.agents/skills/superpowers -> ~/.codex/superpowers/skills` - For Cursor, skills must be installed under `.cursor/skills/` (repo-local) or `~/.cursor/skills/` (global) - Shared reviewer runtime must be installed beside agent skills when using reviewer CLIs: - - Codex: `~/.codex/skills/reviewer-runtime/run-review.sh` - - Claude Code: `~/.claude/skills/reviewer-runtime/run-review.sh` - - OpenCode: `~/.config/opencode/skills/reviewer-runtime/run-review.sh` - - Cursor: `.cursor/skills/reviewer-runtime/run-review.sh` or `~/.cursor/skills/reviewer-runtime/run-review.sh` + - Codex: `~/.codex/skills/reviewer-runtime/{run-review.sh,notify-telegram.sh}` + - Claude Code: `~/.claude/skills/reviewer-runtime/{run-review.sh,notify-telegram.sh}` + - OpenCode: `~/.config/opencode/skills/reviewer-runtime/{run-review.sh,notify-telegram.sh}` + - Cursor: `.cursor/skills/reviewer-runtime/{run-review.sh,notify-telegram.sh}` or `~/.cursor/skills/reviewer-runtime/{run-review.sh,notify-telegram.sh}` + - Pi: `.pi/skills/reviewer-runtime/pi/{run-review.sh,notify-telegram.sh}` or `~/.pi/agent/skills/reviewer-runtime/pi/{run-review.sh,notify-telegram.sh}` - Telegram notification setup is documented in [TELEGRAM-NOTIFICATIONS.md](./TELEGRAM-NOTIFICATIONS.md) If dependencies are missing, stop and return: @@ -95,6 +96,31 @@ mkdir -p ~/.cursor/skills/reviewer-runtime cp -R skills/reviewer-runtime/* ~/.cursor/skills/reviewer-runtime/ ``` +### Pi + +Recommended full Pi package install: + +```bash +./scripts/install-pi-package.sh --global +# or, for project-local Pi package install +./scripts/install-pi-package.sh --local +``` + +Manual single-skill Pi install from the package mirror: + +```bash +./scripts/sync-pi-package-skills.sh +mkdir -p .pi/skills/implement-plan +cp -R pi-package/skills/implement-plan/* .pi/skills/implement-plan/ +mkdir -p .pi/skills/reviewer-runtime/pi +cp -R skills/reviewer-runtime/pi/* .pi/skills/reviewer-runtime/pi/ +chmod +x .pi/skills/reviewer-runtime/pi/*.sh +``` + +Global manual installs use `~/.pi/agent/skills/implement-plan/` and `~/.pi/agent/skills/reviewer-runtime/pi/` instead of `.pi/skills/...`. + +Pi workflow skills also require Superpowers. See [PI-SUPERPOWERS.md](./PI-SUPERPOWERS.md) and [PI-COMMON-REVIEWER.md](./PI-COMMON-REVIEWER.md). + ## Verify Installation ```bash @@ -102,10 +128,12 @@ test -f ~/.codex/skills/implement-plan/SKILL.md || true test -f ~/.claude/skills/implement-plan/SKILL.md || true test -f ~/.config/opencode/skills/implement-plan/SKILL.md || true test -f .cursor/skills/implement-plan/SKILL.md || test -f ~/.cursor/skills/implement-plan/SKILL.md || true +test -f .pi/skills/implement-plan/SKILL.md || test -f ~/.pi/agent/skills/implement-plan/SKILL.md || true test -x ~/.codex/skills/reviewer-runtime/run-review.sh || true test -x ~/.claude/skills/reviewer-runtime/run-review.sh || true test -x ~/.config/opencode/skills/reviewer-runtime/run-review.sh || true test -x .cursor/skills/reviewer-runtime/run-review.sh || test -x ~/.cursor/skills/reviewer-runtime/run-review.sh || true +test -x .pi/skills/reviewer-runtime/pi/run-review.sh || test -x ~/.pi/agent/skills/reviewer-runtime/pi/run-review.sh || true ``` Verify Superpowers execution dependencies exist in your agent skills root: @@ -126,6 +154,10 @@ Verify Superpowers execution dependencies exist in your agent skills root: - Cursor: `.cursor/skills/superpowers/skills/using-git-worktrees/SKILL.md` or `~/.cursor/skills/superpowers/skills/using-git-worktrees/SKILL.md` - Cursor: `.cursor/skills/superpowers/skills/verification-before-completion/SKILL.md` or `~/.cursor/skills/superpowers/skills/verification-before-completion/SKILL.md` - Cursor: `.cursor/skills/superpowers/skills/finishing-a-development-branch/SKILL.md` or `~/.cursor/skills/superpowers/skills/finishing-a-development-branch/SKILL.md` +- Pi: `.pi/skills/superpowers/executing-plans/SKILL.md` or `~/.pi/agent/skills/superpowers/executing-plans/SKILL.md` or `~/.agents/skills/superpowers/executing-plans/SKILL.md` +- Pi: `.pi/skills/superpowers/using-git-worktrees/SKILL.md` or `~/.pi/agent/skills/superpowers/using-git-worktrees/SKILL.md` or `~/.agents/skills/superpowers/using-git-worktrees/SKILL.md` +- Pi: `.pi/skills/superpowers/verification-before-completion/SKILL.md` or `~/.pi/agent/skills/superpowers/verification-before-completion/SKILL.md` or `~/.agents/skills/superpowers/verification-before-completion/SKILL.md` +- Pi: `.pi/skills/superpowers/finishing-a-development-branch/SKILL.md` or `~/.pi/agent/skills/superpowers/finishing-a-development-branch/SKILL.md` or `~/.agents/skills/superpowers/finishing-a-development-branch/SKILL.md` ## Key Behavior @@ -147,14 +179,14 @@ Verify Superpowers execution dependencies exist in your agent skills root: After each milestone is implemented and verified, the skill sends it to a second model for review: -1. **Configure** — user picks a reviewer CLI (`codex`, `claude`, `cursor`) and model, or skips +1. **Configure** — user picks a reviewer CLI (`codex`, `claude`, `cursor`, `pi`) and model, or skips 2. **Prepare** — milestone payload and a bash reviewer command script are written to temp files 3. **Run** — the command script is executed through `reviewer-runtime/run-review.sh` when installed 4. **Feedback** — reviewer evaluates correctness, acceptance criteria, code quality, test coverage, security, and returns `## Summary`, `## Findings`, and `## Verdict` 5. **Prioritize** — findings are ordered `P0`, `P1`, `P2`, `P3` 6. **Revise** — the implementing agent addresses findings in priority order, re-verifies, and re-submits 7. **Repeat** — up to max rounds (default 10) until the reviewer returns `VERDICT: APPROVED` -7. **Approve** — milestone is marked approved in `story-tracker.md` +8. **Approve** — milestone is marked approved in `story-tracker.md` ### Reviewer Output Contract @@ -203,7 +235,7 @@ ts= level= state= --trust --output-format json` | Yes (`--resume `) | `--mode=ask` | | `pi` | See [PI-COMMON-REVIEWER.md](./PI-COMMON-REVIEWER.md) | No (fresh call each round) | `--tools read,grep,find,ls` | -For all three CLIs, the preferred execution path is: +For all supported reviewer CLIs, the preferred execution path is: 1. write the reviewer command to a bash script 2. run that script through `reviewer-runtime/run-review.sh` diff --git a/docs/PI.md b/docs/PI.md index 7f3feb5..26eebc9 100644 --- a/docs/PI.md +++ b/docs/PI.md @@ -124,7 +124,7 @@ When a source Pi variant changes: npm pack --dry-run --json ``` -The installer intentionally does not run sync. It assumes the checked-in `pi-package/skills/*` mirror is already current. +The focused `scripts/install-pi-package.sh` installer intentionally does not run sync. It assumes the checked-in `pi-package/skills/*` mirror is already current. The multi-client skill manager plans a sync step before manual Pi skill-copy operations so manual installs use the current package-facing mirror. The verifier is responsible for catching: diff --git a/docs/README.md b/docs/README.md index 843228e..84e698f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,6 +2,13 @@ This directory contains user-facing docs for each skill. +## Recommended Reading Flow + +1. Use [INSTALLER.md](./INSTALLER.md) for the guided install/update/remove wizard (`./scripts/manage-skills.sh`). +2. Use the client docs ([CODEX.md](./CODEX.md), [CLAUDE-CODE.md](./CLAUDE-CODE.md), [CURSOR.md](./CURSOR.md), [OPENCODE.md](./OPENCODE.md)) for manual installs, and [PI.md](./PI.md) for Pi overview, package install, and manual single-skill copy. +3. Use the skill docs below for skill-specific requirements, runtime setup, verification, and examples. +4. For Pi workflow skills, also consult [PI-SUPERPOWERS.md](./PI-SUPERPOWERS.md) and [PI-COMMON-REVIEWER.md](./PI-COMMON-REVIEWER.md). + ## Index - [INSTALLER.md](./INSTALLER.md) — Skill manager wizard for installing, updating/reinstalling, and removing repo skills across supported clients. diff --git a/docs/WEB-AUTOMATION.md b/docs/WEB-AUTOMATION.md index 15eb7b5..f2a82c6 100644 --- a/docs/WEB-AUTOMATION.md +++ b/docs/WEB-AUTOMATION.md @@ -60,6 +60,31 @@ pnpm approve-builds pnpm rebuild better-sqlite3 esbuild ``` +### Pi + +Recommended full Pi package install: + +```bash +./scripts/install-pi-package.sh --global +# or, for project-local Pi package install +./scripts/install-pi-package.sh --local +``` + +Manual single-skill Pi install from the package mirror: + +```bash +./scripts/sync-pi-package-skills.sh +mkdir -p .pi/skills/web-automation +cp -R pi-package/skills/web-automation/* .pi/skills/web-automation/ +cd .pi/skills/web-automation/scripts +pnpm install --frozen-lockfile +npx cloakbrowser install +pnpm approve-builds +pnpm rebuild better-sqlite3 esbuild +``` + +Global manual installs use `~/.pi/agent/skills/web-automation/` instead of `.pi/skills/web-automation/`. + ## Update To The Latest CloakBrowser Run inside the installed `scripts/` directory for the variant you are using: