Ploy CLI
A reliable command surface for people, automations, and AI agents.
The Ploy CLI is a standalone command-line interface for managing workspaces, sites, domains, routing, structured data, content, and publishing workflows. Use it interactively, from repeatable automations, or as a structured way for agents to operate Ploy.
The installed
ploybinary does not require Bun, Node.js, or npm. The installer supports macOS and Linux on arm64 and x64.
Quick start
Install the CLI, then ploy login for interactive use or set PLOY_API_TOKEN for CI and other headless environments.
curl -fsSL https://ploy.ai/install.sh | sh
ploy login
ploy workspace use
ploy site use
ploy site statusInteractive selectors require a terminal. For scripts and CI, pass explicit IDs with --workspace, workspace use --id, and site use --id.
Get started
Choose the workflow that matches what you want to do next:
- Bring an existing Astro repository: satisfy the publish contract and follow the migration path in Bring your own repo.
- Manage a site: create, publish, connect domains, configure routing, and run Code Sync with Workspaces, sites, domains, and publishing.
- Create an automation: manage reusable content and workflows with Documents and Ploybooks.
- Work with structured data: manage PloyDB databases, tables, columns, and rows, or import CSV files with the database commands.
- Local development: connect your site with Code Sync, install Ploy skills, and give your coding agent design-system context with the local development guide.
- Remote agents and CI: authenticate without a browser and run non-interactive workflows with the remote environments guide.
What you can do
| Workflow | Start here |
|---|---|
| Install, update, and configure | Installation and updates |
| Sign in and manage credentials | Authentication and tokens |
| Bring an existing Astro repository | Repository and publish contract |
| Manage sites, domains, routing, and publishing | Workspaces, sites, domains, and Code Sync |
| Manage runtime configuration | Variables, Secrets, and dotenv imports |
| Manage and import structured data | Databases, tables, columns, rows, and CSV imports |
| Work with content and automations | Documents and Ploybooks |
| Develop locally with your agent | Code Sync, skills, and design-system inspection |
| Run Ploy remotely | Remote agents and CI |
| Use the CLI from agents and automations | Global contract and command index |
Command help
The built-in help stays aligned with the installed version:
ploy help
ploy help site
ploy site publish --help
ploy --version