Octov0.11.17
Referenceoctopaas CLI

octopaas files

Read and write an integration's config files one at a time

An integration's definition is a set of config files: integration.yaml and whatever it splits its flows into. These commands work on one file at a time; to work on all of them, pull and push the integration instead.

A file is named by its path inside the integration, slashes and all.

Also: file.

octopaas files cat

Print one config file.

octopaas files cat <integration> <path>

Also: get.

Examples

octopaas files cat billing integration.yaml
octopaas files cat billing flows/invoices.yaml > invoices.yaml

octopaas files list

List an integration's config files.

octopaas files list <integration>

Also: ls.

Examples

octopaas files list billing

octopaas files put

Write one config file, creating it if it is new. The content comes from --from, a file or - for stdin.

octopaas files put <integration> <path> [flags]

Examples

octopaas files put billing flows/invoices.yaml --from ./invoices.yaml
echo "flows: []" | octopaas files put billing flows/empty.yaml --from -

Flags

FlagWhat it doesDefault
--fromthe file to upload, or - for stdin

octopaas files rm

Delete one config file.

octopaas files rm <integration> <path> [flags]

Also: delete.

Examples

octopaas files rm billing flows/old.yaml --yes

Flags

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

On this page