Creodrop CLI

The Creodrop CLI lets you manage your Developer tier sites from the terminal. Run Drush commands, SSH into environments, generate aliases, and more.

Installation

npm install -g @creodrop/cli

Or with pnpm:

pnpm add -g @creodrop/cli

Authentication

Before using any commands, log in with your Creodrop account:

creodrop login

You will be prompted for your email and password. Your session token is stored locally at ~/.creodrop/config.json.

To log out:

creodrop logout

Commands

List Sites

View all your sites:

creodrop sites

Displays a table with site name, ID, tier, and status.

Run Drush Commands

Execute Drush commands on a specific environment:

creodrop drush @{site-id}.{env} {command}

Examples:

# Rebuild cache on production
creodrop drush @a1b2c3d4.prod cache:rebuild

# Get a login link on development
creodrop drush @a1b2c3d4.dev uli

# Export config on staging
creodrop drush @a1b2c3d4.stage config:export -y

# Dump the dev database locally
creodrop drush @a1b2c3d4.dev sql-dump > dev-backup.sql

The command output is streamed to your terminal, and the CLI exits with the same exit code as the remote command.

SSH into an Environment

Open an SSH session to any environment:

creodrop ssh {site-id} {env}

Examples:

creodrop ssh a1b2c3d4 dev
creodrop ssh a1b2c3d4 prod

This spawns a local SSH connection to {site-id}-{env}@ssh.creodrop.com on port 2222. You must have an SSH key configured in Account Settings.

View Logs

Stream container logs from an environment:

creodrop logs {site-id} {env}
creodrop logs {site-id} {env} --follow

Generate Drush Aliases

Create a Drush alias file so you can use native drush @alias syntax:

creodrop drush-aliases

This generates ~/.drush/sites/creodrop.site.yml with aliases for all your Developer tier sites. Each site gets entries for all three environments:

# After running drush-aliases, you can use native drush:
drush @creodrop.a1b2c3d4.prod cache:rebuild
drush @creodrop.a1b2c3d4.dev sql-dump > backup.sql
drush @creodrop.a1b2c3d4.stage status

Aliases use SSH transport through the Creodrop SSH gateway, so your SSH key must be configured.

Configuration

The CLI stores configuration at ~/.creodrop/config.json:

{
  "apiUrl": "https://api.creodrop.com",
  "token": "your-jwt-token"
}

To point the CLI at a different API (e.g., local development):

# Edit ~/.creodrop/config.json and change apiUrl

Troubleshooting

“Not authenticated” errors Run creodrop login to refresh your session.

“Command not allowed” errors Only allowlisted commands can be executed remotely. See Developer Tier for the list of allowed commands.

SSH connection refused Make sure you have added your SSH public key in Account Settings. Keys must be added before SSH or Drush aliases will work.

Drush aliases not working Run creodrop drush-aliases to regenerate the alias file. Make sure your SSH key is configured and that you have at least one Developer tier site.