Skip to content

CLI Reference

This document contains the command-line reference for the InfraWeave CLI.

infraweave

Handles all InfraWeave CLI operations

Usage: infraweave <COMMAND>

Subcommands:
  • provider — Handles provider operations
  • module — Handles module operations
  • stack — Handles stack operations
  • policy — Handles policy operations
  • gitops — GitOps operations for detecting and processing manifest changes
  • get-current-project — Get current project
  • get-all-projects — Get all projects
  • plan — Plan a claim to a specific environment
  • driftcheck — Check drift of a deployment in a specific environment
  • apply — Apply a claim to a specific environment
  • destroy — Delete resources in cloud
  • get-claim — Get YAML claim from a deployment
  • get-logs — Download logs for a specific job ID
  • deployments — Work with deployments
  • admin — Admin operations for advanced users (workspace setup, state file access) Requires elevated permissions to perform operations
  • ui — Launch interactive TUI for exploring modules and deployments
  • mcp — MCP server commands for AI tools like Claude Desktop, VSCode Copilot, etc.
  • upgrade — Upgrade to the latest released version of InfraWeave

infraweave provider

Handles provider operations

Usage: infraweave provider <COMMAND>

Subcommands:
  • publish —
  • list —

infraweave provider publish

Usage: infraweave provider publish [OPTIONS] <PATH>

Arguments:
  • <PATH> — Path to the provider to publish, e.g. provider.yaml
Options:
  • -r, --ref <REF> — Metadata field for storing any type of reference, e.g. a git commit hash
  • -d, --description <DESCRIPTION> — Metadata field for storing a description of the provider, e.g. a git commit message
  • -v, --version <VERSION> — Set version instead of in the provider file, only stable version allowed e.g. "1.0.2"
  • --no-fail-on-exist — Flag to indicate if the return code should be 0 if it already exists, otherwise 1

infraweave provider list

Usage: infraweave provider list

infraweave module

Handles module operations

Usage: infraweave module <COMMAND>

Subcommands:
  • publish — Upload and publish a module to a specific track
  • precheck — Precheck a module before publishing by testing provided examples
  • list — List all latest versions of modules from a specific track
  • get — List information about specific version of a module
  • versions — List all versions of a specific module on a track
  • version — Configure versions for a module
  • deprecate — Deprecate a specific version of a module

infraweave module publish

Upload and publish a module to a specific track

Usage: infraweave module publish [OPTIONS] <TRACK> <PATH>

Arguments:
  • <TRACK> — Track to publish to, e.g. dev, beta, stable
  • <PATH> — Path to the module to publish, e.g. ./src
Options:
  • -r, --ref <REF> — Metadata field for storing any type of reference, e.g. a git commit hash
  • -d, --description <DESCRIPTION> — Metadata field for storing a description of the module, e.g. a git commit message
  • -v, --version <VERSION> — Override version instead of using version from the module file
  • --no-fail-on-exist — Do not fail if the module version already exists

infraweave module precheck

Precheck a module before publishing by testing provided examples

Usage: infraweave module precheck [ENVIRONMENT_ID] <FILE> [REF] [DESCRIPTION]

Arguments:
  • <ENVIRONMENT_ID> — Environment id to publish to, e.g. cli/default (optional, will prompt if not provided)
  • <FILE> — Path to the module to precheck, e.g. ./src
  • <REF> — Metadata field for storing any type of reference, e.g. a git commit hash
  • <DESCRIPTION> — Metadata field for storing a description of the module, e.g. a git commit message

infraweave module list

List all latest versions of modules from a specific track

Usage: infraweave module list <TRACK>

Example: 

$ infraweave module list dev
s3bucket         v0.1.4
ec2instance      v0.2.1
rdspostgres      v1.0.0

Arguments:
  • <TRACK> — Track to list from, e.g. dev, beta, stable

infraweave module get

List information about specific version of a module

Usage: infraweave module get <MODULE> <VERSION>

Example: 

$ infraweave module get s3bucket 0.1.4
Name: s3bucket
Version: 0.1.4
Track: dev
Created: 2025-10-15 14:30:00

Arguments:
  • <MODULE> — Module name to get, e.g. s3bucket
  • <VERSION> — Version to get, e.g. 0.1.4

infraweave module versions

List all versions of a specific module on a track

Usage: infraweave module versions <MODULE> <TRACK>

Example: 

$ infraweave module versions s3bucket dev
VERSION    STATUS       CREATED
v0.1.4     Active       2025-10-15 14:30:00
v0.1.3     DEPRECATED   2025-10-12 10:20:00
v0.1.2     Active       2025-10-10 09:15:00

Arguments:
  • <MODULE> — Module name, e.g. s3bucket
  • <TRACK> — Track to list from, e.g. dev, beta, stable

infraweave module version

Configure versions for a module

Usage: infraweave module version <COMMAND>

Subcommands:
  • promote — Promote a version of a module to a new track, e.g. add 0.4.7 in dev to 0.4.7 in prod
infraweave module version promote

Promote a version of a module to a new track, e.g. add 0.4.7 in dev to 0.4.7 in prod

Usage: infraweave module version promote

infraweave module deprecate

Deprecate a specific version of a module

Usage: infraweave module deprecate [OPTIONS] <MODULE> <TRACK> <VERSION>

Arguments:
  • <MODULE> — Module name to deprecate, e.g. s3bucket
  • <TRACK> — Track of the module, e.g. dev, beta, stable
  • <VERSION> — Version to deprecate, e.g. 0.1.4
Options:
  • -m, --message <MESSAGE> — Optional message explaining why the module version is deprecated

infraweave stack

Handles stack operations

Usage: infraweave stack <COMMAND>

Subcommands:
  • preview — Preview a stack before publishing
  • publish — Upload and publish a stack to a specific track
  • list — List all latest versions of stacks from a specific track
  • get — List information about specific version of a stack
  • versions — List all versions of a specific stack on a track
  • deprecate — Deprecate a specific version of a stack

infraweave stack preview

Preview a stack before publishing

Usage: infraweave stack preview <PATH>

Arguments:
  • <PATH> — Path to the stack to preview, e.g. ./src

infraweave stack publish

Upload and publish a stack to a specific track

Usage: infraweave stack publish [OPTIONS] <TRACK> <PATH>

Arguments:
  • <TRACK> — Track to publish to, e.g. dev, beta, stable
  • <PATH> — Path to the stack to publish, e.g. ./src
Options:
  • -r, --ref <REF> — Metadata field for storing any type of reference, e.g. a git commit hash
  • -d, --description <DESCRIPTION> — Metadata field for storing a description of the stack, e.g. a git commit message
  • -v, --version <VERSION> — Override version instead of using version from the stack file
  • --no-fail-on-exist — Do not fail if the stack version already exists

infraweave stack list

List all latest versions of stacks from a specific track

Usage: infraweave stack list <TRACK>

Example: 

$ infraweave stack list dev
bucketcollection  v0.1.0
networkstack      v0.2.5

Arguments:
  • <TRACK> — Track to list from, e.g. dev, beta, stable

infraweave stack get

List information about specific version of a stack

Usage: infraweave stack get <STACK> <VERSION>

Example: 

$ infraweave stack get bucketcollection 0.1.0
Name: bucketcollection
Version: 0.1.0
Track: dev
Created: 2025-10-15 14:30:00

Arguments:
  • <STACK> — Stack name to get, e.g. bucketcollection
  • <VERSION> — Version to get, e.g. 0.1.0

infraweave stack versions

List all versions of a specific stack on a track

Usage: infraweave stack versions <STACK> <TRACK>

Example: 

$ infraweave stack versions bucketcollection dev
VERSION    STATUS       CREATED
v0.1.0     Active       2025-10-15 14:30:00
v0.0.9     DEPRECATED   2025-10-12 10:20:00

Arguments:
  • <STACK> — Stack name, e.g. bucketcollection
  • <TRACK> — Track to list from, e.g. dev, beta, stable

infraweave stack deprecate

Deprecate a specific version of a stack

Usage: infraweave stack deprecate [OPTIONS] <STACK> <TRACK> <VERSION>

Arguments:
  • <STACK> — Stack name to deprecate, e.g. bucketcollection
  • <TRACK> — Track of the stack, e.g. dev, beta, stable
  • <VERSION> — Version to deprecate, e.g. 0.1.4
Options:
  • -m, --message <MESSAGE> — Optional message explaining why the stack version is deprecated

infraweave policy

Handles policy operations

Usage: infraweave policy <COMMAND>

Subcommands:
  • publish — Upload and publish a policy to a specific environment (not yet functional)
  • list — List all latest versions of policies from a specific environment
  • get — List information about specific version of a policy

infraweave policy publish

Upload and publish a policy to a specific environment (not yet functional)

Usage: infraweave policy publish [ENVIRONMENT_ID] <FILE> [REF] [DESCRIPTION]

Arguments:
  • <ENVIRONMENT_ID> — Environment id to publish to, e.g. cli/default (optional, will prompt if not provided)
  • <FILE> — Path to the policy to publish, e.g. ./src
  • <REF> — Metadata field for storing any type of reference, e.g. a git commit hash
  • <DESCRIPTION> — Metadata field for storing a description of the policy, e.g. a git commit message

infraweave policy list

List all latest versions of policies from a specific environment

Usage: infraweave policy list [ENVIRONMENT_ID]

Arguments:
  • <ENVIRONMENT_ID> — Environment to list from, e.g. aws, azure (optional, will prompt if not provided)

infraweave policy get

List information about specific version of a policy

Usage: infraweave policy get <POLICY> [ENVIRONMENT_ID] <VERSION>

Arguments:
  • <POLICY> — Policy name to get, e.g. s3bucket
  • <ENVIRONMENT_ID> — Environment id to get from, e.g. cli/default (optional, will prompt if not provided)
  • <VERSION> — Version to get, e.g. 0.1.4

infraweave gitops

GitOps operations for detecting and processing manifest changes

Usage: infraweave gitops <COMMAND>

Subcommands:
  • diff — Detect changed manifests between two git references In GitHub Actions, use ${{ github.event.before }} and ${{ github.event.after }} For local testing, defaults to HEAD~1 (before) and HEAD (after)

infraweave gitops diff

Detect changed manifests between two git references In GitHub Actions, use ${{ github.event.before }} and ${{ github.event.after }} For local testing, defaults to HEAD~1 (before) and HEAD (after)

Usage: infraweave gitops diff [OPTIONS]

Options:
  • --before <BEFORE> — Git reference to compare from (e.g., commit SHA, branch, or HEAD~1 for local testing) In GitHub Actions: use ${{ github.event.before }}
  • --after <AFTER> — Git reference to compare to (e.g., commit SHA, branch, or HEAD for local testing) In GitHub Actions: use ${{ github.event.after }}

infraweave get-current-project

Get current project

Usage: infraweave get-current-project

infraweave get-all-projects

Get all projects

Usage: infraweave get-all-projects

infraweave plan

Plan a claim to a specific environment

Usage: infraweave plan [OPTIONS] <CLAIM>

Arguments:
  • <CLAIM> — Claim file to deploy, e.g. claim.yaml
Options:
  • -e, --environment-id <ENVIRONMENT_ID> — Environment id used when planning, e.g. cli/default (optional, will prompt if not provided)
  • --store-files — Flag to indicate if output files should be stored
  • --destroy — Flag to plan a destroy operation
  • --follow — Follow the plan operation progress

infraweave driftcheck

Check drift of a deployment in a specific environment

Usage: infraweave driftcheck [OPTIONS] [DEPLOYMENT_ID]

Arguments:
  • <DEPLOYMENT_ID> — Deployment id to check, e.g. s3bucket/my-s3-bucket (optional, will prompt if not provided)
Options:
  • -e, --environment-id <ENVIRONMENT_ID> — Environment id used when checking drift, e.g. cli/default (optional, will prompt if not provided)
  • --remediate — Flag to indicate if remediate should be performed

infraweave apply

Apply a claim to a specific environment

Usage: infraweave apply [OPTIONS] <CLAIM>

Arguments:
  • <CLAIM> — Claim file to apply, e.g. claim.yaml
Options:
  • -e, --environment-id <ENVIRONMENT_ID> — Environment id used when applying, e.g. cli/default (optional, will prompt if not provided)
  • --store-files — Flag to indicate if output files should be stored
  • --follow — Follow the apply operation progress

infraweave destroy

Delete resources in cloud

Usage: infraweave destroy [OPTIONS] [DEPLOYMENT_ID]

Arguments:
  • <DEPLOYMENT_ID> — Deployment id to remove, e.g. s3bucket/my-s3-bucket (optional, will prompt if not provided)
Options:
  • -e, --environment-id <ENVIRONMENT_ID> — Environment id where the deployment exists, e.g. cli/default (optional, will prompt if not provided)
  • -v, --version <VERSION> — Optional override version of module/stack used during destroy
  • --store-files — Flag to indicate if output files should be stored
  • --follow — Follow the destroy operation progress

infraweave get-claim

Get YAML claim from a deployment

Usage: infraweave get-claim [OPTIONS] [DEPLOYMENT_ID]

Arguments:
  • <DEPLOYMENT_ID> — Deployment id to get claim for, e.g. s3bucket/my-s3-bucket (optional, will prompt if not provided)
Options:
  • -e, --environment-id <ENVIRONMENT_ID> — Environment id of the existing deployment, e.g. cli/default (optional, will prompt if not provided)

infraweave get-logs

Download logs for a specific job ID

Usage: infraweave get-logs [OPTIONS] <JOB_ID>

Arguments:
  • <JOB_ID> — Job ID to download logs for
Options:
  • -o, --output <OUTPUT> — Optional output file path (prints to stdout if not specified)

infraweave deployments

Work with deployments

Usage: infraweave deployments <COMMAND>

Subcommands:
  • list — List all deployments for a specific environment
  • describe — Describe a specific deployment

infraweave deployments list

List all deployments for a specific environment

Usage: infraweave deployments list

infraweave deployments describe

Describe a specific deployment

Usage: infraweave deployments describe [ENVIRONMENT_ID] [DEPLOYMENT_ID]

Arguments:
  • <ENVIRONMENT_ID> — Environment id where the deployment exists, e.g. cli/default (optional, will prompt if not provided)
  • <DEPLOYMENT_ID> — Deployment id to describe, e.g. s3bucket/my-s3-bucket (optional, will prompt if not provided)

infraweave admin

Admin operations for advanced users (workspace setup, state file access) Requires elevated permissions to perform operations

Usage: infraweave admin <COMMAND>

Subcommands:
  • setup-workspace — Set up a workspace for manual intervention on a specific deployment
  • get-state — Download the Terraform state file for a specific deployment

infraweave admin setup-workspace

Set up a workspace for manual intervention on a specific deployment

Usage: infraweave admin setup-workspace [ENVIRONMENT_ID] [DEPLOYMENT_ID]

Arguments:
  • <ENVIRONMENT_ID> — Environment id of the deployment, e.g. cli/default (optional, will prompt if not provided)
  • <DEPLOYMENT_ID> — Deployment id to set up workspace for, e.g. s3bucket/s3bucket-my-s3-bucket-7FV (optional, will prompt if not provided)

infraweave admin get-state

Download the Terraform state file for a specific deployment

Usage: infraweave admin get-state [OPTIONS] [ENVIRONMENT_ID] [DEPLOYMENT_ID]

Arguments:
  • <ENVIRONMENT_ID> — Environment id of the deployment, e.g. cli/default (optional, will prompt if not provided)
  • <DEPLOYMENT_ID> — Deployment id to get state for, e.g. s3bucket/s3bucket-my-s3-bucket-7FV (optional, will prompt if not provided)
Options:
  • -o, --output <OUTPUT> — Optional output file path (prints to stdout if not specified)

infraweave ui

Launch interactive TUI for exploring modules and deployments

Usage: infraweave ui

infraweave mcp

MCP server commands for AI tools like Claude Desktop, VSCode Copilot, etc.

Usage: infraweave mcp [COMMAND]

Subcommands:
  • setup-vscode — Configure MCP server in VS Code's global settings
  • setup-claude — Configure MCP server in Claude Desktop's config

infraweave mcp setup-vscode

Configure MCP server in VS Code's global settings

Usage: infraweave mcp setup-vscode

infraweave mcp setup-claude

Configure MCP server in Claude Desktop's config

Usage: infraweave mcp setup-claude

infraweave upgrade

Upgrade to the latest released version of InfraWeave

Usage: infraweave upgrade [OPTIONS]

Options:
  • --check — Only check for available upgrades without installing
  • --prerelease — Include pre-release versions (e.g. beta, rc)

This document was generated automatically by clap-markdown.