Referenceoctopaas CLI
octopaas resources
Manage the resources an integration carries
Resources are what an integration carries besides its flows: env files, templates, prompts and so on. Each has a kind, a name (its path, which may contain slashes) and content, and is addressed by its id.
Also: resource, res.
octopaas resources create
Add a resource.
octopaas resources create <integration> [flags]Examples
octopaas resources create billing --kind template --name templates/invoice.html --from invoice.htmlFlags
| Flag | What it does | Default |
|---|---|---|
--from | the file holding its content, or - for stdin | |
--kind | what the resource is, such as env or template | |
--name | its path inside the integration (default: the --from file's name) |
octopaas resources get
Show a resource.
octopaas resources get <integration> <resource-id> [flags]Examples
octopaas resources get billing 3f1c…
octopaas resources get billing 3f1c… --content > prompt.mdFlags
| Flag | What it does | Default |
|---|---|---|
--content | print only the resource's content |
octopaas resources list
List an integration's resources.
octopaas resources list <integration>Also: ls.
Examples
octopaas resources list billingoctopaas resources rm
Delete a resource.
octopaas resources rm <integration> <resource-id> [flags]Also: delete.
Examples
octopaas resources rm billing 3f1c… --yesFlags
| Flag | What it does | Default |
|---|---|---|
-y, --yes | do not ask first |
octopaas resources update
Replace a resource.
octopaas resources update <integration> <resource-id> [flags]Examples
octopaas resources update billing 3f1c… --kind template --name templates/invoice.html --from invoice.htmlFlags
| Flag | What it does | Default |
|---|---|---|
--from | the file holding its content, or - for stdin | |
--kind | what the resource is, such as env or template | |
--name | its path inside the integration (default: the --from file's name) |