Skip to content

README.md

Latest commit

 

History

History
164 lines (106 loc) · 4.74 KB

README.md

File metadata and controls

164 lines (106 loc) · 4.74 KB

cli

Infracost estimates cloud costs from infrastructure as code, helping you catch cost surprises before they hit your bill. It currently supports Terraform, Terragrunt, and CloudFormation.

Installation

The quickest way to install on macOS or Linux:

curl -fsSL https://raw.githubusercontent.com/infracost/cli/main/scripts/install.sh | sh

To pin a specific version, set INFRACOST_VERSION:

curl -fsSL https://raw.githubusercontent.com/infracost/cli/main/scripts/install.sh | INFRACOST_VERSION=v2.0.0 sh

Or download the archive for your platform from the GitHub Releases page, extract the binary and place it on your PATH:

# macOS (Apple Silicon)
tar -xzf infracost-darwin-arm64.tar.gz
mv infracost /usr/local/bin/infracost

# Linux (amd64)
tar -xzf infracost-linux-amd64.tar.gz
mv infracost /usr/local/bin/infracost

On Windows, download the .zip archive and extract it to a directory on your PATH.

Once installed, verify it works:

infracost help

Uninstalling

Remove the binary and the cached configuration/token data.

On macOS:

rm $(which infracost)
rm -rf "$HOME/Library/Application Support/infracost"

On Linux:

rm $(which infracost)
rm -rf "${XDG_CONFIG_HOME:-$HOME/.config}/infracost"

On Windows (PowerShell):

Remove-Item (Get-Command infracost).Source
Remove-Item -Recurse "$env:APPDATA\infracost"

Building locally

If you prefer to build from source:

  1. make build
  2. ./bin/infracost help

Usage

Login

Before running any commands, authenticate with Infracost:

infracost auth login

This opens a browser-based login flow (PKCE). The resulting token is cached locally so you only need to log in once. If you don't have access to a browser or localhost, use the device flow instead:

infracost auth login --oauth-use-device-flow

For non-interactive environments (CI/CD), set the INFRACOST_CLI_AUTHENTICATION_TOKEN environment variable to a service account token or personal access token instead of using the login command.

Setup

Once logged in, the interactive setup wizard walks you through configuring AI coding agents, your IDE, and CI:

infracost setup

Scan

infracost scan /path/to/directory

The target must be a directory. If no argument is given, it defaults to the current working directory. The CLI will auto-detect the IaC type from the directory contents, or you can configure projects explicitly via an infracost.yml config file.

Inspect

View a summary of the most recent scan results without re-running analysis:

infracost inspect --summary

Plugins

Plugins are downloaded automatically from the manifest when you run the CLI. No manual setup is required.

Version Pinning

By default, the CLI downloads the latest version of each plugin. You can pin to a specific version using environment variables:

  • INFRACOST_CLI_PARSER_PLUGIN_VERSION — pin the parser plugin version
  • INFRACOST_CLI_PROVIDER_PLUGIN_AWS_VERSION — pin the AWS provider plugin version
  • INFRACOST_CLI_PROVIDER_PLUGIN_AZURE_VERSION — pin the Azure provider plugin version
  • INFRACOST_CLI_PROVIDER_PLUGIN_GOOGLE_VERSION — pin the Google provider plugin version

Updates

Plugins auto-update by default. Set INFRACOST_CLI_PLUGIN_AUTO_UPDATE=false to disable automatic plugin updates. When disabled, the CLI uses the latest cached version if one exists, and only downloads from the manifest if no cached version is found.

To update the CLI itself, you can use the update command. This will update the CLI binary by downloading the latest release from GitHub. Note that this does not update plugins, which are managed separately as described above.

Local Plugin Overrides

If you are developing plugins locally, you can bypass the download mechanism entirely by pointing the CLI at your local builds:

# Parser
export INFRACOST_CLI_PARSER_PLUGIN=/path/to/bin/infracost-parser-plugin

# Providers
export INFRACOST_CLI_PROVIDER_PLUGIN_AWS=/path/to/bin/infracost-provider-plugin-aws
export INFRACOST_CLI_PROVIDER_PLUGIN_GOOGLE=/path/to/bin/infracost-provider-plugin-google
export INFRACOST_CLI_PROVIDER_PLUGIN_AZURERM=/path/to/bin/infracost-provider-plugin-azurerm

When a plugin path override is set, the CLI uses that binary directly and skips downloading for that plugin.

Bugs and feedback

If you run into any issues or have feedback, please open a thread in GitHub Discussions.

Contributing

We ❤️ contributions big or small. Please start by opening a thread in GitHub Discussions to discuss your idea before submitting a PR.