CLI Commands
The Convox CLI provides commands for managing your Racks, Apps, Builds, Services, Resources, and infrastructure. Run convox help to see all available commands, or convox <command> -h for help on a specific command.
Authentication
| Command | Description |
|---|---|
| login | Authenticate with a Rack |
| switch | Switch current Rack |
App Management
| Command | Description |
|---|---|
| apps | List Apps |
| apps cancel | Cancel an App update |
| apps create | Create an App |
| apps delete | Delete an App |
| apps export | Export an App |
| apps import | Import an App |
| apps info | Get information about an App |
| apps lock | Enable termination protection |
| apps params | Display App parameters |
| apps params set | Set App parameters |
| apps unlock | Disable termination protection |
| apps wait | Wait for an App to finish updating |
Builds
| Command | Description |
|---|---|
| build | Create a Build |
| builds | List Builds |
| builds export | Export a Build |
| builds import | Import a Build |
| builds info | Get information about a Build |
| builds logs | Get logs for a Build |
Deployment
| Command | Description |
|---|---|
| deploy | Create and promote a Build |
| releases | List Releases for an App |
| releases info | Get information about a Release |
| releases manifest | Get manifest for a Release |
| releases promote | Promote a Release |
| releases rollback | Copy an old Release forward and promote it |
Environment Variables
| Command | Description |
|---|---|
| env | List env vars |
| env edit | Edit env vars interactively |
| env get | Get an env var |
| env set | Set env var(s) |
| env unset | Unset env var(s) |
Processes
| Command | Description |
|---|---|
| ps | List App processes |
| ps info | Get information about a process |
| ps stop | Stop a process |
| exec | Execute a command in a running process |
| run | Execute a command in a new process |
| cp | Copy files to/from a process |
Services
| Command | Description |
|---|---|
| services | List Services for an App |
| services restart | Restart a Service |
| restart | Restart all processes for an App |
| scale | Scale a Service |
| start | Start an App for local development |
Certificates
| Command | Description |
|---|---|
| certs | List certificates |
| certs delete | Delete a certificate |
| certs generate | Generate a certificate |
| certs import | Import a certificate |
| ssl | List certificate associations for an App |
| ssl update | Update certificate for an App |
Logs
| Command | Description |
|---|---|
| logs | Get logs for an App |
| rack logs | Get logs for the Rack |
Instances
| Command | Description |
|---|---|
| instances | List instances |
| instances keyroll | Roll SSH key on instances |
| instances ssh | Run a shell on an instance |
| instances terminate | Terminate an instance |
Rack Management
| Command | Description |
|---|---|
| rack | Get information about the Rack |
| rack install | Install a Rack |
| rack params | Display Rack parameters |
| rack params set | Set Rack parameters |
| rack ps | List Rack processes |
| rack releases | List Rack version history |
| rack scale | Scale the Rack |
| rack sync | Sync v2 Rack API URL |
| rack uninstall | Uninstall a Rack |
| rack update | Update the Rack |
| rack wait | Wait for Rack to finish updating |
| racks | List available Racks |
Rack Access
| Command | Description |
|---|---|
| rack access | Generate Rack access credentials |
| rack access key rotate | Rotate Rack access key |
| rack runtimes | List attachable runtime integrations |
| rack runtime attach | Attach a runtime integration to the Rack |
| rack sync whitelist instances ip | Sync whitelisted instance IPs in security group |
App Resources
| Command | Description |
|---|---|
| resources | List Resources for an App |
| resources info | Get information about a Resource |
| resources proxy | Proxy a local port to a Resource |
| resources url | Get URL for a Resource |
Rack Resources
| Command | Description |
|---|---|
| rack resources | List Rack Resources |
| rack resources create | Create a Resource |
| rack resources delete | Delete a Resource |
| rack resources info | Get information about a Resource |
| rack resources link | Link a Resource to an App |
| rack resources options | List options for a Resource type |
| rack resources proxy | Proxy a local port to a Rack Resource |
| rack resources types | List Resource types |
| rack resources unlink | Unlink a Resource from an App |
| rack resources update | Update Resource options |
| rack resources url | Get URL for a Resource |
Registries
| Command | Description |
|---|---|
| registries | List private registries |
| registries add | Add a private registry |
| registries remove | Remove a private registry |
Networking
| Command | Description |
|---|---|
| proxy | Proxy a connection inside the Rack |
Utilities
| Command | Description |
|---|---|
| api get | Query the Rack API |
| encrypt | Encrypt data using a symmetric key |
| decrypt | Decrypt data using a symmetric key |
| test | Run tests |
| update | Update the CLI |
| version | Display version information |
See Also
