ready-deploy CLI

Deploy and manage resources on ready.dev from your terminal (or agent!).

Install

curl -fsSL https://get.ready.dev/ready-deploy -o ready-deploy && chmod +x ready-deploy

Authentication

Set the READY_API_KEY environment variable before running any commands. API keys are managed under your cluster admin.

Keep your keys safe

Never expose API keys in client-side code or commit them to version control. Use environment variables or a secrets manager.

Environment Variable

export READY_API_KEY=insert_your_key_here

Git Deployments

Deploy or update a git-based resource.

Usage

ready-deploy git [flags] [project] [resource]

Flag	Description
-port int	Application port (required for new deploys)
-domain string	Full domain, e.g. `app.example.com` or `myapp.mycluster.rdy.ws`
-env string	Environment variables as `KEY=val,KEY2=val2`
-repo string	GitHub repo URL (auto-detected from git remote if omitted)
-branch string	Branch to deploy (auto-detected if omitted)
-folder string	Subfolder in repo (default `/`)
-dry-run	Preview the deploy without making changes
-no-wait	Return immediately without polling for completion

Redeploy

Trigger a fresh deploy of an existing resource without changing its configuration.

Usage

ready-deploy git redeploy [project] [resource]

Rollback

Roll back to a previous deploy.

Usage

ready-deploy git rollback [project] [resource] <hash>

Databases

Create or update managed database instances.

MySQL

Usage

ready-deploy mysql [flags] [project] [resource]

Flag	Description
-username string	Database username
-password string	Database password
-database string	Database name
-dry-run	Preview without making changes
-no-wait	Return immediately without polling

PostgreSQL

Usage

ready-deploy postgres [flags] [project] [resource]

Accepts the same flags as MySQL: -username, -password, -database, -dry-run, -no-wait.

Argument Defaults

The CLI applies sensible defaults so you can skip boilerplate in most cases.

Argument	Default
project	Current folder name
resource	`app` for git commands, `db` for database commands
-repo	Auto-detected from git remote
-branch	Auto-detected from current branch

Examples

Deploy to a custom domain

ready-deploy git -domain app.example.com -port 3000

Redeploy an existing resource

ready-deploy git redeploy

Rollback to a specific deploy

ready-deploy git rollback abc123

Add a PostgreSQL database

ready-deploy postgres

Deploy with environment variables

ready-deploy git -port 3000 -env NODE_ENV=production,SECRET_KEY=abc123

Dry run a deploy

ready-deploy git -port 8080 -dry-run

Using with AI Agents

The ready-deploy CLI ships with an agent skill file that lets AI coding assistants deploy to ready.dev on your behalf.

Agents should pull and install the skill file:

https://get.ready.dev/ready-deploy.md

Example Prompts

Deploy an app

Install and run the skill at https://get.ready.dev/ready-deploy.md to deploy my app to ready

Create a MySQL database

Use the skill at https://get.ready.dev/ready-deploy.md to create a MySQL database for my project

The skill file teaches the agent to infer your project settings (port, repo, branch) automatically and run the appropriate ready-deploy command. If something is ambiguous — like which port your app listens on — the agent will ask before proceeding.