Running commands

Note

The documentation for opentf-ctl has been split into multiple sections. You can find links below to the new locations of the original sections. You may want to update your bookmarks accordingly.

Basic commands

• get workflows List active and recent workflows
• run workflow {filename} Start a workflow
• get workflow {workflow_id} Get a workflow status
• kill workflow {workflow_id} Cancel a running workflow

Agent Commands

• get agents List registered agents
• delete agent {agent_id} De-register an agent

Channel Commands

• get channels List known channels

Qualitygate Commands

• get qualitygate {workflow_id} Get quality gate status for a workflow
• describe qualitygate {workflow_id} Get description of a quality gate status for a workflow

Token Commands

• generate token using {key} Interactively generate a signed token
• check token {token} using {key} Check if token signature matches public key
• view token {token} Show token payload

Advanced Commands

• get namespaces List accessible namespaces
• get subscriptions List active subscriptions
• delete subscription {sub_id} Cancel an active subscription

Other Commands

• config Modify current opentf-tools configuration
• version List the tools version