Octov0.11.17
Referenceoctopaas CLI

octopaas integrations

Create, edit, pull and push integrations

Integrations are the flows you build. Every command takes an integration by name or by id.

The quickest way to edit one is to pull it into a folder, change the files with any editor, and push it back: it keeps its id, its versions and its deployments.

Also: integration, int.

Examples

octopaas integrations list
octopaas integrations pull billing
$EDITOR billing/integration.yaml
octopaas integrations push billing ./billing

octopaas integrations create

Create an integration from its YAML definition. To create one with resources as well, import a bundle instead.

octopaas integrations create <name> [flags]

Examples

octopaas integrations create billing --file octo.yaml
cat octo.yaml | octopaas integrations create billing --file -

Flags

FlagWhat it doesDefault
-f, --filethe YAML definition, or - for stdin

octopaas integrations get

Show an integration, or with --definition print just its YAML, ready to redirect into a file.

octopaas integrations get <integration> [flags]

Examples

octopaas integrations get billing
octopaas integrations get billing --definition > octo.yaml

Flags

FlagWhat it doesDefault
--definitionprint only the integration's YAML

octopaas integrations import

Create a new integration from a folder or a bundle. Its name is the one the bundle carries, or --name when it carries none; a taken name gets a numbered suffix.

octopaas integrations import <folder | bundle.zip> [flags]

Examples

octopaas integrations import ./billing --name billing
octopaas integrations import billing.zip

Flags

FlagWhat it doesDefault
--namethe name to use when the bundle carries none (default: the folder's)

octopaas integrations list

List integrations.

octopaas integrations list

Also: ls.

Examples

octopaas integrations list
octopaas int ls -o json | jq -r '.[].name'

octopaas integrations pull

Download an integration, definition and resources, and unpack it into a folder (by default one named after it). The folder must be empty unless you add --force, which overwrites the files the bundle carries and leaves the rest. The bundle's manifest goes in .octo/octo-bundle.json, where push finds it, and .octo/pulled-from.json records which integration it came from, in which environment, so push takes it back there.

With --zip, the bundle is saved as it came instead.

octopaas integrations pull <integration> [folder] [flags]

Examples

octopaas integrations pull billing
octopaas integrations pull billing ./work/billing --force
octopaas integrations pull billing --zip billing.zip

Flags

FlagWhat it doesDefault
--forceunpack into a folder that already has files
--zipsave the bundle as this .zip instead of unpacking it

octopaas integrations push

Pack a folder (by default the one named after the integration) and replace the integration's contents with it. It keeps its id, name, versions and deployments; running deployments are untouched until you roll them out.

Hidden files and folders, such as .git and .env, are never pushed, unless the platform sent them: a folder you pulled pushes back the hidden resources it came with. The manifest pull keeps in .octo/octo-bundle.json is rewritten to match the folder, so files you added are pushed and files you deleted are removed.

A folder pulled from another integration is refused, which is what the same name is in another environment: push it back with --environment, or remove .octo/pulled-from.json to push it here.

octopaas integrations push <integration> [folder | bundle.zip]

Examples

octopaas integrations push billing
octopaas integrations push billing ./work/billing
octopaas integrations push billing billing.zip

octopaas integrations rename

Rename an integration.

octopaas integrations rename <integration> <new-name>

Examples

octopaas integrations rename billing invoicing

octopaas integrations rm

Delete an integration, with its files, resources and versions. There is no undo.

octopaas integrations rm <integration> [flags]

Also: delete.

Examples

octopaas integrations rm scratchpad
octopaas integrations rm scratchpad --yes

Flags

FlagWhat it doesDefault
-y, --yesdo not ask first

On this page