https://github.com/dev-thought/pulumi-npm
An NPM executable package for Pulumis CLI.
https://github.com/dev-thought/pulumi-npm
code-as-infrastructure pulumi
Last synced: 7 months ago
JSON representation
An NPM executable package for Pulumis CLI.
- Host: GitHub
- URL: https://github.com/dev-thought/pulumi-npm
- Owner: Dev-Thought
- Created: 2020-01-14T20:07:35.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T05:41:11.000Z (about 3 years ago)
- Last Synced: 2025-04-19T07:56:25.783Z (11 months ago)
- Topics: code-as-infrastructure, pulumi
- Language: JavaScript
- Size: 94.7 KB
- Stars: 4
- Watchers: 1
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# pulumi-npm
_An NPM executable package for Pulumi._
[](https://github.com/prettier/prettier) [](https://www.pulumi.com) [](https://www.npmjs.com/package/@dev-thought/pulumi-npm)
### Preamble
I assembled [Pulumi](https://pulumi.com) 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:
```json
{
"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:
```bash
# 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:
```bash
# 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:
```json
{
"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:
```bash
pulumi version # show version info
Pulumi # show usage info
```
## Stay in touch
- Twitter Author - [Mitko Tschimev](https://twitter.com/MTschimev)
## License
This Module is [MIT licensed](LICENSE).
## Contributors
Thanks to all contributions which makes this library more stable and more powerful :)
- [Anh-Vu Nguyen](https://github.com/anhvun)
- [Antonio Terreno](https://github.com/aterreno)