Pulumi CLI overview

Pulumi is controlled primarily using the command line interface (CLI). It works in conjunction with the Pulumi Cloud to deploy changes to your cloud apps and infrastructure. It keeps a history of who updated what in your team and when. This CLI has been designed for great inner loop productivity, in addition to continuous integration and delivery scenarios.

Installation

The Pulumi CLI is open source and free to use:

Install Pulumi

Common Commands

The most common commands in the CLI that you’ll be using are as follows:

• pulumi new: creates a new project using a template
• pulumi stack: manage your stacks (at least one is required to perform an update)
• pulumi config: configure variables such as keys, regions, and so on
• pulumi up: preview and deploy changes to your program and/or infrastructure
• pulumi preview: preview your changes explicitly before deploying
• pulumi destroy: destroy your program and its infrastructure when you’re done
• pulumi api: call any Pulumi Cloud REST API endpoint directly from the CLI

Complete Reference

For the complete, versioned documentation of every Pulumi CLI command, see the CLI command reference.

Environment Variables

For a list of environment variables that you can use to work with the Pulumi CLI, see Environment variables.

Error and exit codes

To learn how Pulumi maps internal errors to stable CLI exit codes you can use in automation, see Pulumi CLI exit codes.