All Commands
Every Out Plane CLI command, with what it changes.
Every command the CLI ships, with what it does and whether running it changes anything. Use it to find the command you want, then follow it for the arguments, the flags, the output fields and the errors.
The same surface is available to a program, with types and examples, from
outplane schema. It needs no credential and makes no network call.
| Command | What It Does | Risk | Changes Anything |
|---|---|---|---|
app list | List the applications in a team. | read | no |
app get | Show one application in detail. | read | no |
app create | Create an application and deploy it. | write | yes |
app scale | Change how many instances an application runs, and how large they are. | write | yes |
app pause | Stop an application without deleting it. | write | yes |
app resume | Start a paused application. | write | yes |
app instances | List the instances an application is actually running. | read | no |
app delete | Permanently delete an application. | destructive | yes |
login | Sign in to a team. | write | yes |
logout | Remove a stored credential. | write | yes |
whoami | Show the active credential. | read | no |
build get | Show how an application is built. | read | no |
build set | Change how an application is built. | write | yes |
app rename | Change the label an application is shown under. | write | yes |
schema | Print the machine-readable description of every command. | read | no |
help | Explain a topic that is not a command. | read | no |
version | Print the version of this CLI. | read | no |
completion | Print a shell completion script. | read | no |
db list | List the team's managed databases. | read | no |
db get | Show one database and what is inside it. | read | no |
db url | Print a connection string. | read | no |
db create | Provision a managed PostgreSQL database. | write | yes |
db delete | Permanently destroy a database. | destructive | yes |
db role list | List the logins a database accepts. | read | no |
db role create | Add a login to a database. | write | yes |
db role delete | Remove a login. | destructive | yes |
db database list | List the databases inside a managed instance. | read | no |
db database create | Add a database inside a managed instance. | write | yes |
db database delete | Destroy a database inside an instance. | destructive | yes |
deploy create | Build and deploy an application. | write | yes |
deploy list | List recent deployments. | read | no |
deploy get | Show one deployment. | read | no |
deploy logs | Show the build output of one deployment. | read | no |
domain list | List the team's custom domains. | read | no |
domain dns | Show the DNS record a host needs. | read | no |
domain add | Register a custom domain. | write | yes |
domain point | Send a domain to an application. | write | yes |
domain unpoint | Stop a domain going anywhere, keeping it registered. | write | yes |
domain remove | Give up a custom domain. | destructive | yes |
env list | List an application's environment variables. | read | no |
env get | Print one environment variable. | read | no |
env set | Set environment variables. | write | yes |
env unset | Remove environment variables. | write | yes |
env pull | Write an application's environment variables to a file. | read | no |
env push | Set an application's environment variables from a file. | write | yes |
env run | Run a local command with an application's environment variables. | write | yes |
env group list | List the team's shared variable groups. | read | no |
env group get | Show what a group holds. | read | no |
env group create | Create a shared variable group. | write | yes |
env group set | Change a group's variables or settings. | write | yes |
env group assign | Give an application a group's variables. | write | yes |
env group unassign | Stop an application using a group. | write | yes |
env group delete | Permanently delete a variable group. | destructive | yes |
ip-profile list | List the team's IP access profiles. | read | no |
ip-profile get | Show one profile, its rules and what uses it. | read | no |
ip-profile create | Create an IP access profile. | write | yes |
ip-profile set | Change a profile's rules, name or description. | write | yes |
ip-profile delete | Permanently delete an IP access profile. | destructive | yes |
ip-profile assign | Restrict an application to a profile's networks. | write | yes |
ip-profile unassign | Stop an application using a profile. | write | yes |
link | Point this directory at a team, and optionally an application. | write | yes |
unlink | Remove this directory's link. | write | yes |
logs | Show what an application printed. | read | no |
metrics | Show what applications are using right now. | read | no |
port list | List the ports an application serves. | read | no |
port get | Print one port's address. | read | no |
port set | Open a port, or change one that is already open. | write | yes |
port unset | Stop an application serving a port. | write | yes |
api | Call an API endpoint the CLI has no command for. | destructive | yes |
registry list | List the team's private registry credentials. | read | no |
registry create | Store a login for a private registry. | write | yes |
registry delete | Remove a private registry credential. | destructive | yes |
repos | List the repositories you can deploy from. | read | no |
requests | Show the HTTP requests an application received. | read | no |
app shell | Open an interactive shell on a running instance. | write | yes |
skills install | Install the Out Plane agent skill into your coding tools. | write | yes |
skills list | Show where the agent skill is installed, and which version. | read | no |
skills update | Replace an installed agent skill with the newest release. | write | yes |
skills remove | Remove the Out Plane agent skill from your coding tools. | write | yes |
status | Show which team and credential the next command will use. | read | no |
team list | List the teams this machine is signed in to. | read | no |
team use | Choose the team commands act on by default. | write | yes |
update | Install the newest version of this CLI. | write | yes |
volume list | List the team's disks. | read | no |
volume get | Show one disk. | read | no |
volume create | Create a disk, and optionally mount it. | write | yes |
volume attach | Mount a disk on an application. | write | yes |
volume detach | Unmount a disk, keeping it and its contents. | write | yes |
volume delete | Permanently destroy a disk and its contents. | destructive | yes |