Agent Setup
Onboard Claude Code, Codex, Cursor, or any other AI coding agent to Ploy with one copy-paste prompt.
Agent Setup
Ploy is new, so most AI coding agents know little or nothing about it. Paste this prompt into your agent to give it everything it needs to build and deploy on Ploy:
Fetch and execute the appropriate instructions to set me up for Ploy from https://docs.meetploy.com/agent-setup/prompt.mdThe same prompt is one click away under Onboard your agent to Ploy on the dashboard overview and the Ploy homepage.
What the agent does
The instructions tell the agent to run every step itself:
- Install the Ploy AI skills globally with
npx skills, so every agent on the machine can scaffold workers, Next.js apps, databases, queues, workflows, and auth. - Install the Ploy CLI and run
ploy auth login. This is the only step that needs you: approve the login in the browser window it opens. - Add a one-line hint to the agent's user-level instructions file (for example
~/.claude/CLAUDE.mdor~/.codex/AGENTS.md) telling it to read the Ploy docs before writing Ploy code. - Learn the platform from a summary of
ploy.yaml, every binding, the worker handlers, frameworks, local development, deploying, and theploy apicommands for logs, deployments, and environment variables.
When it finishes, the agent prints a short summary of what it installed.
The prompt works with any agent that can fetch a URL and run shell commands, including Claude Code, Codex, Cursor, GitHub Copilot, OpenCode, and Windsurf.
Self-hosted Ploy
The instructions default to the hosted platform. On a self-hosted instance, set PLOY_API_URL to your API URL before the agent runs ploy auth login, or include your instance's URL in the same message as the prompt.
Related
How is this guide?
Last updated on