Out Plane

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.

CommandWhat It DoesRiskChanges Anything
app listList the applications in a team.readno
app getShow one application in detail.readno
app createCreate an application and deploy it.writeyes
app scaleChange how many instances an application runs, and how large they are.writeyes
app pauseStop an application without deleting it.writeyes
app resumeStart a paused application.writeyes
app instancesList the instances an application is actually running.readno
app deletePermanently delete an application.destructiveyes
loginSign in to a team.writeyes
logoutRemove a stored credential.writeyes
whoamiShow the active credential.readno
build getShow how an application is built.readno
build setChange how an application is built.writeyes
app renameChange the label an application is shown under.writeyes
schemaPrint the machine-readable description of every command.readno
helpExplain a topic that is not a command.readno
versionPrint the version of this CLI.readno
completionPrint a shell completion script.readno
db listList the team's managed databases.readno
db getShow one database and what is inside it.readno
db urlPrint a connection string.readno
db createProvision a managed PostgreSQL database.writeyes
db deletePermanently destroy a database.destructiveyes
db role listList the logins a database accepts.readno
db role createAdd a login to a database.writeyes
db role deleteRemove a login.destructiveyes
db database listList the databases inside a managed instance.readno
db database createAdd a database inside a managed instance.writeyes
db database deleteDestroy a database inside an instance.destructiveyes
deploy createBuild and deploy an application.writeyes
deploy listList recent deployments.readno
deploy getShow one deployment.readno
deploy logsShow the build output of one deployment.readno
domain listList the team's custom domains.readno
domain dnsShow the DNS record a host needs.readno
domain addRegister a custom domain.writeyes
domain pointSend a domain to an application.writeyes
domain unpointStop a domain going anywhere, keeping it registered.writeyes
domain removeGive up a custom domain.destructiveyes
env listList an application's environment variables.readno
env getPrint one environment variable.readno
env setSet environment variables.writeyes
env unsetRemove environment variables.writeyes
env pullWrite an application's environment variables to a file.readno
env pushSet an application's environment variables from a file.writeyes
env runRun a local command with an application's environment variables.writeyes
env group listList the team's shared variable groups.readno
env group getShow what a group holds.readno
env group createCreate a shared variable group.writeyes
env group setChange a group's variables or settings.writeyes
env group assignGive an application a group's variables.writeyes
env group unassignStop an application using a group.writeyes
env group deletePermanently delete a variable group.destructiveyes
ip-profile listList the team's IP access profiles.readno
ip-profile getShow one profile, its rules and what uses it.readno
ip-profile createCreate an IP access profile.writeyes
ip-profile setChange a profile's rules, name or description.writeyes
ip-profile deletePermanently delete an IP access profile.destructiveyes
ip-profile assignRestrict an application to a profile's networks.writeyes
ip-profile unassignStop an application using a profile.writeyes
linkPoint this directory at a team, and optionally an application.writeyes
unlinkRemove this directory's link.writeyes
logsShow what an application printed.readno
metricsShow what applications are using right now.readno
port listList the ports an application serves.readno
port getPrint one port's address.readno
port setOpen a port, or change one that is already open.writeyes
port unsetStop an application serving a port.writeyes
apiCall an API endpoint the CLI has no command for.destructiveyes
registry listList the team's private registry credentials.readno
registry createStore a login for a private registry.writeyes
registry deleteRemove a private registry credential.destructiveyes
reposList the repositories you can deploy from.readno
requestsShow the HTTP requests an application received.readno
app shellOpen an interactive shell on a running instance.writeyes
skills installInstall the Out Plane agent skill into your coding tools.writeyes
skills listShow where the agent skill is installed, and which version.readno
skills updateReplace an installed agent skill with the newest release.writeyes
skills removeRemove the Out Plane agent skill from your coding tools.writeyes
statusShow which team and credential the next command will use.readno
team listList the teams this machine is signed in to.readno
team useChoose the team commands act on by default.writeyes
updateInstall the newest version of this CLI.writeyes
volume listList the team's disks.readno
volume getShow one disk.readno
volume createCreate a disk, and optionally mount it.writeyes
volume attachMount a disk on an application.writeyes
volume detachUnmount a disk, keeping it and its contents.writeyes
volume deletePermanently destroy a disk and its contents.destructiveyes