CLI commands

CLI commands

The 91 koast CLI commands, generated from the API operations, with their flags and an example each.

The koast CLI turns each API operation into a command named by its operationId. Install and sign in as the CLI guide explains.

Flag naming

The brandId path parameter is --brand.
Other path and query parameters and top-level body fields are flags in kebab case: launchId is --launch-id.
Path parameters are required. An array flag is repeatable or takes a JSON array. An object flag takes JSON.
A boolean flag with no value means true.
--json <file|-> gives the whole request body. Body flags are applied over it.

Global flags

Flag	What it does
`--api-url <url>`	Use another API base URL. Defaults to `https://api.koast.ai`, or `KOAST_API_URL` when set.
`--refresh`	Download the OpenAPI document again before running.
`--output <json\|table>`	Output format. Defaults to `json`.
`--all`	Paged commands only: follow every page and print one JSON line per item.
`--idempotency-key <key>`	Send this `Idempotency-Key`.
`--json <file\|->`	The request body as JSON, from a file or stdin. Body flags are applied over it.
`--help`	Help for the CLI or for one command.
`--version`	The CLI version.
`--api-key <key\|->`	`login` only: store an API key instead of signing in with a browser.
`--no-browser`	`login` only: print the sign-in URL instead of opening it.

Built-in commands

Command	What it does
`koast login`	Sign in with a browser, or store an API key with `--api-key`.
`koast logout`	Remove the stored credential for the current API URL.
`koast help [command]`	Help for the CLI or for one command.
`koast commands [--output json]`	List every command, grouped by tag.

Commands by tag

Activity

get-team-activity-log: Get team activity log

Ad Accounts

get-account-naming-convention: Get account naming convention
get-account-overview: Get account overview
get-available-options: Get asset and targeting options
list-account-campaigns: List ad account campaigns
list-lead-forms: List lead forms

Automations

delete-automation: Delete automation
get-automation: Get automation
list-automations: List automations
save-automation: Save automation
set-automation-status: Set automation status

Brands

list-my-ad-accounts: List my ad accounts

Copies

generate-copy: Generate ad copy
get-copy: Get generated ad copy

Creatives

list-creatives: List creatives
upload-creative: Upload creative

Integrations

connect-clickflare: Connect ClickFlare
disconnect-clickflare: Disconnect ClickFlare
get-clickflare-cost-push: Get ClickFlare spend push
get-clickflare-settings: Get ClickFlare settings
get-redtrack-cost-push: Get RedTrack spend push
list-clickflare-campaign-mappings: List ClickFlare campaign mappings
list-redtrack-campaign-mappings: List RedTrack campaign mappings
update-clickflare-campaign-mapping: Update ClickFlare campaign mapping
update-clickflare-cost-push: Update ClickFlare spend push
update-clickflare-settings: Update ClickFlare settings
update-redtrack-campaign-mapping: Update RedTrack campaign mapping
update-redtrack-cost-push: Update RedTrack spend push

Launches

add-ads: Add ads
add-adset: Add ad set
add-campaign: Add campaign
apply-snapshot-template: Apply campaign snapshot template
apply-structure-template: Apply structure template
attach-lead-form: Attach lead form
clone-live-campaign: Clone live campaign
compute-creative-fatigue: Compute creative fatigue
create-campaign-launch: Create campaign launch
delete-batch: Delete batch or pipeline card
distribute-creative: Distribute creative
duplicate-and-vary: Duplicate and vary
duplicate-node: Duplicate ad set or ad
edit-live-campaign: Edit live campaign budget
get-ad-delivery-status: Get ad delivery status
get-ad-details: Get ad details
get-adset-details: Get ad set details
get-campaign-tree: Get campaign tree
get-insights-daily: Get daily insights
get-metrics: Get metrics
get-settings: Get settings
get-targeting-options: Get targeting options
import-campaigns: Import campaigns
import-live-campaign: Import live campaign
launch-campaign: Launch campaign
list-koast-batches: List Koast batches
remove-nodes: Remove items from campaign tree
rename-node: Rename campaign, ad set or ad
save-campaign-snapshot: Save campaign snapshot template
swap-creatives: Swap creatives
turn-launch-into-template: Turn launch into structure template
update-node: Update campaign, ad set or ad
update-settings: Update settings
validate-launch: Validate launch

Pipeline

configure-pipeline-column: Configure pipeline column
create-pipeline-ticket: Create pipeline card
list-pipeline-columns: List pipeline columns
move-pipeline-card: Move pipeline card

Snapshot Templates

delete-snapshot-template: Delete campaign snapshot template
list-snapshot-templates: List campaign snapshot templates

Structure Templates

author-structure-template: Create structure template
delete-structure-template: Delete structure template
edit-structure-template-rules: Edit structure template rules
get-structure-template: Get structure template
list-structure-templates: List structure templates

Webhooks

create-webhook-endpoint: Create webhook endpoint
delete-webhook-endpoint: Delete webhook endpoint
enable-webhook-endpoint: Enable webhook endpoint
get-webhook-endpoint: Get webhook endpoint
get-webhook-secret: Get webhook secret
list-webhook-deliveries: List webhook deliveries
list-webhook-endpoints: List webhook endpoints
resend-failed-webhook-deliveries: Resend failed webhook deliveries
rotate-webhook-secret: Rotate webhook secret
test-webhook-endpoint: Send webhook test event
update-webhook-endpoint: Update webhook endpoint

Workflows

delete-workflow: Delete workflow
get-workflow: Get workflow
get-workflow-execution: Get workflow execution
list-workflows: List workflows
run-workflow: Run workflow
save-workflow: Save workflow
set-workflow-status: Set workflow status

Validate structure rules

Validate an engine StructureState against the rules engine WITHOUT saving.

Activity commands

The 1 koast CLI command for the Activity operations.