Octov0.11.17
Referenceoctopaas CLI

octopaas CLI reference

Every octopaas command, its flags and examples, as `--help` prints them.

octopaas is the command line for an Octo platform's public API.

It edits integrations and their files, freezes them into versions, deploys those versions and follows what they log, all as you: your roles decide what it may do, and every change is attributed to you.

Sign in once with octopaas auth login. For automation, set OCTOPAAS_URL and OCTOPAAS_KEY instead and no sign-in or config file is needed.

For installing it, signing in and using it in CI/CD, see the octopaas guide.

Commands

CommandWhat it does
octopaas authSign in, sign out, and see how you are signed in
octopaas configLook at the config file
octopaas environmentsList environments, and choose the one your commands act in
octopaas profileSwitch between the platforms you work with
octopaas whoamiWho you are signed in as, and where
octopaas filesRead and write an integration's config files one at a time
octopaas integrationsCreate, edit, pull and push integrations
octopaas resourcesManage the resources an integration carries
octopaas versionsFreeze integrations into versions you can deploy
octopaas deploymentsDeploy versions, scale them, roll them out and take them down
octopaas logsRead or follow what a deployment logs
octopaas apiCall any API route with your credential
octopaas completionGenerate the autocompletion script for the specified shell
octopaas upgradeUpgrade octopaas to the newest release
octopaas versionPrint octopaas's version
octopaas environmentThe environment variables octopaas reads, and CI/CD use

Flags every command takes

FlagWhat it doesDefault
--environmentthe environment to act in (default: $OCTOPAAS_ENVIRONMENT, then the profile's, then octo)
--plainno colours, animations or art, even in a terminal
--urlthe API to talk to, overriding the profile (default: $OCTOPAAS_URL)
-o, --outputhow to print results: table, json or yamltable
-p, --profilethe profile to use (default: $OCTOPAAS_PROFILE, then the config's current one)

On this page