Skip to content

Document setup as regular onboarding guide #196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chubes4 merged 1 commit into from
Jun 7, 2026
Merged

Document setup as regular onboarding guide #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,10 @@ cd ~/Studio/my-wordpress-website && kimaki # OpenCode + Discord

#### Let Your Agent Do It

Use the one-shot `wp-coding-agents-setup` entrypoint with your local coding agent (Claude Code, Cursor, etc.):
Use the one-shot setup guide with your local coding agent (Claude Code, Cursor, etc.):

```
operator-entrypoints/wp-coding-agents-setup/
operator-entrypoints/wp-coding-agents-setup/setup.md
```

Then: "Help me set up wp-coding-agents on my VPS"
Expand Down
22 changes: 8 additions & 14 deletions ...trypoints/wp-coding-agents-setup/SKILL.md → ...trypoints/wp-coding-agents-setup/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
---
name: wp-coding-agents-setup
description: "Orchestrate wp-coding-agents setup on a VPS or local WordPress install by collecting a setup profile, compiling the exact setup.sh command, dry-running it, and guiding verification."
compatibility: "For VPS: requires SSH access, Ubuntu/Debian recommended. For local: requires an existing WordPress install (WordPress Studio, MAMP, manual, etc.) and Node.js."
---

# WP Coding Agents Setup

Use this skill from the operator's **local machine** to install wp-coding-agents on a remote VPS or an existing local WordPress install. Once the runtime and chat bridge are installed, the new site agent takes over ongoing WordPress management.
This is the one-shot setup guide for installing wp-coding-agents on a remote VPS or existing local WordPress install. Use it from the operator's local machine before the target agent exists. Once the runtime and chat bridge are installed, the site agent takes over ongoing WordPress management.

This skill is only the orchestrator. Keep the setup matrix composable:
## Onboarding Flow

```text
wp-coding-agents-setup
operator-entrypoints/wp-coding-agents-setup/setup.md
-> operator-entrypoints/wp-coding-agents-setup/interview.md
-> scripts/compile-setup-profile.mjs
-> dry-run setup command
Expand All @@ -33,7 +27,7 @@ Use the scripts for operational details:
| WordPress/WP-CLI behavior | `lib/wordpress.sh` |
| Upgrade behavior | `./upgrade.sh --help` and `upgrade-wp-coding-agents` |

Do not duplicate script internals in this skill. Compile commands from the user's setup profile, then verify against script output.
Do not duplicate script internals in this guide. Compile commands from the setup profile, then verify against script output.

## Procedure

Expand Down Expand Up @@ -74,13 +68,13 @@ Do not duplicate script internals in this skill. Compile commands from the user'
- Keep Codebox minion provider auth separate from optional WP AI Gateway external-client setup.
- Keep Homeboy external to wp-coding-agents. The WordPress site root is a Homeboy project, not a component.
- Use `WP_CMD="studio wp"` for WordPress Studio installs when the compiler selects that overlay.
- Use `--with-homeboy` only when the user wants the optional developer layer.
- Use `--no-chat` when the user wants terminal/SSH-only operation.
- Use `--no-skills` only when the user explicitly wants to skip installing the upgrade skill on the target runtime.
- Use `--with-homeboy` only when the operator wants the optional developer layer.
- Use `--no-chat` when the operator wants terminal/SSH-only operation.
- Use `--no-skills` only when the operator explicitly wants to skip installing the upgrade skill on the target runtime.

## When To Use

Use when the user says things like:
Use when the operator says things like:

- "Help me install wp-coding-agents on my server"
- "Set up a coding agent on this VPS"
Expand Down
2 changes: 1 addition & 1 deletion skills/upgrade-wp-coding-agents/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ By default it also updates the setup-installed Data Machine plugins (`data-machi

If the install was created with the optional Homeboy layer, upgrade should preserve that model: the WordPress site root is the Homeboy **project**, primary Data Machine Code workspace checkouts are attached **components**, and `repo@branch` worktrees remain skipped by default. Homeboy is external to wp-coding-agents; do not vendor it or treat the site root as a component during upgrade guidance.

Setup uses `operator-entrypoints/wp-coding-agents-setup/interview.md` and `scripts/compile-setup-profile.mjs` to map a new install profile into commands. Upgrade intentionally does **not** duplicate that compiler: `upgrade.sh` owns detection, bridge selection, dry-run diffs, and summary commands for an already-installed environment.
Setup uses the one-shot guide at `operator-entrypoints/wp-coding-agents-setup/setup.md`, plus `operator-entrypoints/wp-coding-agents-setup/interview.md` and `scripts/compile-setup-profile.mjs`, to map a new install profile into commands. Upgrade intentionally does **not** duplicate that compiler: `upgrade.sh` owns detection, bridge selection, dry-run diffs, and summary commands for an already-installed environment.

## When to use

Expand Down
Loading