Skip to content
InfraWeave Docs

InfraWeave CLI

You can use the Command-Line Interface (CLI) provided by InfraWeave to develop, build, and preview your project from a terminal window.

Use infraweave --help to get the most accurate information to your version.

Command-Line Help for infraweave

This document contains the help content for the infraweave command-line program.

Command Overview:

infraweave

Handles all InfraWeave CLI operations

Usage: infraweave <COMMAND>

Subcommands:
  • module — Handles module operations
  • stack — Handles stack operations
  • policy — Handles policy operations
  • 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
  • environment — Work with environments
  • destroy — Delete resources in cloud
  • get-claim — Get YAML claim from a deployment
  • deployments — Work with deployments
  • ui — Launch interactive TUI for exploring modules and deployments

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
  • version — Configure versions for 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
  • <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>

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>

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

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 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

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 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
  • version — Configure versions for 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
  • <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

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
  • <VERSION> — Version to get, e.g. 0.1.4

infraweave policy version

Configure versions for a policy

Usage: infraweave policy version <COMMAND>

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

infraweave policy version promote

Promote a version of a policy to a new environment, e.g. add 0.4.7 in dev to 0.4.7 in prod

Usage: infraweave policy version promote

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] <ENVIRONMENT_ID> <CLAIM>

Arguments:
  • <ENVIRONMENT_ID> — Environment id used when planning, e.g. cli/default
  • <CLAIM> — Claim file to deploy, e.g. claim.yaml
Options:
  • --store-plan — Flag to indicate if plan files should be stored

infraweave driftcheck

Check drift of a deployment in a specific environment

Usage: infraweave driftcheck [OPTIONS] <ENVIRONMENT_ID> <DEPLOYMENT_ID>

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

infraweave apply

Apply a claim to a specific environment

Usage: infraweave apply <ENVIRONMENT_ID> <CLAIM>

Arguments:
  • <ENVIRONMENT_ID> — Environment id used when applying, e.g. cli/default
  • <CLAIM> — Claim file to apply, e.g. claim.yaml

infraweave environment

Work with environments

Usage: infraweave environment <COMMAND>

Subcommands:
  • list — List all environments

infraweave environment list

List all environments

Usage: infraweave environment list

infraweave destroy

Delete resources in cloud

Usage: infraweave destroy <ENVIRONMENT_ID> <DEPLOYMENT_ID> [VERSION]

Arguments:
  • <ENVIRONMENT_ID> — Environment id where the deployment exists, e.g. cli/default
  • <DEPLOYMENT_ID> — Deployment id to remove, e.g. s3bucket/my-s3-bucket
  • <VERSION> — Optional override version of module/stack used during destroy

infraweave get-claim

Get YAML claim from a deployment

Usage: infraweave get-claim <ENVIRONMENT_ID> <DEPLOYMENT_ID>

Arguments:
  • <ENVIRONMENT_ID> — Environment id of the existing deployment, e.g. cli/default
  • <DEPLOYMENT_ID> — Deployment id to get claim for, e.g. s3bucket/my-s3-bucket

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
  • <DEPLOYMENT_ID> — Deployment id to describe, e.g. s3bucket/my-s3-bucket

infraweave ui

Launch interactive TUI for exploring modules and deployments

Usage: infraweave ui