CLI and coding agents
The ployz CLI does what the dashboard does, from your terminal. Install it, give your coding
agent the Ployz skill, and the agent can deploy and change your services for you.
Install the CLI
Section titled “Install the CLI”curl -fsSL https://ployz.sh | sh
# or with Homebrew
brew install getployz/ployz/ployz
It runs on Linux and macOS. On Windows, install it inside WSL. To upgrade, run the same command
again, or brew upgrade ployz.
Sign in
Section titled “Sign in”- Run
ployz login. It prints a code and opens your browser. - Sign in with GitHub if the page asks.
- On Sign in the Ployz CLI, check that the code matches your terminal, then click Approve.
ployz logout signs this computer out.
Commands act on your only project and its default environment. With more than one, add
--project my-app --env production, or run ployz link --project my-app --env production once in
your app's directory.
Set up your coding agent
Section titled “Set up your coding agent”ployz setup agent
This installs the Ployz skill for coding agents, including Claude Code. Your agent learns every
command and setting from it, ployz --help and ployz schema --json, so you can ask it to
deploy, add a database or read logs.
Run it again after you upgrade the CLI; ployz --help tells you when the skill is out of date.
An agent can also sign you in: it runs ployz login, and you click Approve on the link it
gives you.
Deploy a directory
Section titled “Deploy a directory”From your app's directory:
ployz up
The first time, Ployz creates a project named after the directory, adds a service with an https address, builds your app, deploys it and prints the address.
An upload can be at most 256 MiB compressed. To deploy on every push instead, see Deploy from GitHub.
Make an organization token
Section titled “Make an organization token”CI jobs and scripts sign in with a token instead of a browser. Set it as PLOYZ_TOKEN:
# On your computer: make a token. It's shown once, so copy it.
ployz token new ci
# In CI, with the token stored as the secret PLOYZ_TOKEN
ployz up --project my-app --env production
Always pass --project in CI, or ployz up creates a new project named after the checkout.
The token acts as you in this organization: whoever holds it can deploy and run commands in your
services. It expires after 90 days unless you pass --expires-in (1 to 365 days). To revoke it,
find its ID with ployz token ls, then run ployz token rm ID. If it names a server that's
offline, run it again once that server is back.
Add --json to any command to get one JSON object instead of text.