Skip to main content
The apps command group provides tools for managing applications on your Convox rack. You can create, delete, list, and configure apps, as well as manage app-specific settings like termination protection and parameters.

apps

List all applications on the current rack.

Usage

convox apps

Flags

--rack
string
Specify the rack name

Example Output

$ convox apps
APP          STATUS   RELEASE
myapp        running  RABCDEFGHI
myapp2       running  RIHGFEDCBA

apps cancel

Cancel an ongoing app update or deployment.

Usage

convox apps cancel [app]

Arguments

app
string
Application name (optional, uses current directory app if not specified)

Flags

--app
string
Application name
--rack
string
Rack name

Example

$ convox apps cancel
Cancelling deployment of myapp...
Rewriting last active release...
OK

apps create

Create a new application on the rack.

Usage

convox apps create [name]

Arguments

name
string
Name for the new application

Flags

--rack
string
Rack to create the app on
--generation
string
Application generation (2 or 3)

Example

$ convox apps create myapp
Creating myapp... OK

apps delete

Delete an application and all its resources.

Usage

convox apps delete <app>

Arguments

app
string
required
Name of the application to delete

Flags

--rack
string
Rack name

Example

$ convox apps delete myapp
Deleting myapp... OK
This operation is destructive and will delete all data associated with the app. Make sure to back up any important data first.

apps export

Export an application, including its configuration, build, environment, and resources.

Usage

convox apps export [app]

Arguments

app
string
Application name

Flags

--app
string
Application name
--rack
string
Rack name
--file
string
default:"-f"
Export to file (e.g., myapp.tgz)

Example

$ convox apps export --file myapp.tgz
Exporting app myapp... OK
Exporting env... OK
Exporting build BABCDEFGHI... OK
Exporting resource database... OK
Packaging export... OK

apps import

Import an application from an export file.

Usage

convox apps import [app]

Arguments

app
string
Name for the imported application

Flags

--app
string
Application name
--rack
string
Rack name
--file
string
default:"-f"
Import from file (e.g., myapp.tgz)

Example

$ convox apps import myapp2 --file myapp.tgz
Creating app myapp2... OK
Importing build... OK, RIHGFEDCBA
Importing env... OK, RJIHGFEDCB
Promoting RJIHGFEDCB... OK
Importing resource database... OK

apps info

Display detailed information about an application.

Usage

convox apps info [app]

Arguments

app
string
Application name

Flags

--app
string
Application name
--rack
string
Rack name

Example Output

$ convox apps info
Name        myapp
Status      running
Generation  2
Locked      false
Release     RABCDEFGHI

apps lock

Enable termination protection to prevent accidental deletion.

Usage

convox apps lock [app]

Arguments

app
string
Application name

Flags

--app
string
Application name
--rack
string
Rack name

Example

$ convox apps lock
Locking myapp... OK
When locked, an application cannot be deleted until it is unlocked first.

apps unlock

Disable termination protection.

Usage

convox apps unlock [app]

Arguments

app
string
Application name

Flags

--app
string
Application name
--rack
string
Rack name

Example

$ convox apps unlock
Unlocking myapp... OK

apps params

Display application parameters.

Usage

convox apps params [app]

Arguments

app
string
Application name

Flags

--app
string
Application name
--rack
string
Rack name

apps params set

Set application parameters.

Usage

convox apps params set <Key=Value> [Key=Value]...

Arguments

Key=Value
string
required
One or more parameter key-value pairs

Flags

--app
string
Application name
--rack
string
Rack name

Example

$ convox apps params set MaxCpu=2048 MaxMemory=4096
Updating parameters
...
OK

Build docs developers (and LLMs) love