pulumi-npm

An NPM executable package for Pulumi.

Preamble

I assembled Pulumi into an NPM package in order for me to include it in other projects that depended on the executable. I wanted to be able to publish NPM modules with scripts like this:

{
  "scripts": {
    "plan": "pulumi up"
  }
}

But without having to worry about asking users to download Pulumi externally.

---

Installation

To use Pulumi as an NPM package, include it in your package.json dependencies:

# If you're using Yarn (recommended):
yarn add pulumi-npm

# If you're using NPM:
npm i pulumi-npm

Or, if you want a one-time installation that you can run arbitrarily, install it globally:

# If you're using Yarn (recommended):
yarn global add pulumi-npm

# If you're using NPM:
npm i -g pulumi-npm

Usage

As a project dependency:

This package cannot currently be used as a typical Node module, as it does not export any entry points; it only symlinks a binary. So, the recommended use case is to use it in your package.json scripts:

{
  "scripts": {
    "plan": "pulumi up",
    "destroy": "pulumi destroy"
  }
}

As a globally installed binary:

If you installed this package globally (with npm i -g or yarn global add), you can simply start using it like a regular command-line program:

pulumi version        # show version info
Pulumi                # show usage info

Stay in touch

• Twitter Author - Mitko Tschimev

License

This Module is MIT licensed.

Contributors

Thanks to all contributions which makes this library more stable and more powerful :)

• Anh-Vu Nguyen