2018-05-18 16:41:28 +02:00
|
|
|
# Pulumi Node.js SDK
|
2017-09-11 22:05:01 +02:00
|
|
|
|
2018-05-18 16:41:28 +02:00
|
|
|
The Pulumi Node.js SDK lets you write cloud programs in JavaScript.
|
2017-09-11 22:05:01 +02:00
|
|
|
|
2018-05-18 16:41:28 +02:00
|
|
|
## Installation
|
2017-09-11 22:05:01 +02:00
|
|
|
|
2018-05-18 16:41:28 +02:00
|
|
|
Using npm:
|
2017-09-11 22:05:01 +02:00
|
|
|
|
2018-05-18 16:41:28 +02:00
|
|
|
```bash
|
|
|
|
|
$ npm install --save @pulumi/pulumi
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Using yarn:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
$ yarn add @pulumi/pulumi
|
|
|
|
|
```
|
|
|
|
|
|
2019-07-25 18:58:12 +02:00
|
|
|
This SDK is meant for use with the Pulumi CLI. Please visit
|
|
|
|
|
[pulumi.com](https://pulumi.com) for installation instructions.
|
2017-09-11 22:05:01 +02:00
|
|
|
|
2018-05-18 16:41:28 +02:00
|
|
|
## Building and Testing
|
2017-09-11 22:05:01 +02:00
|
|
|
|
2018-05-18 16:41:28 +02:00
|
|
|
For anybody who wants to build from source, here is how you do it.
|
2017-09-11 22:05:01 +02:00
|
|
|
|
2018-05-18 16:41:28 +02:00
|
|
|
### Prerequisites
|
|
|
|
|
|
2021-05-21 19:46:56 +02:00
|
|
|
This SDK uses Node.js and we support any of the
|
|
|
|
|
[Current, Active and Maintenance LTS versions](https://nodejs.org/en/about/releases/). We support both
|
|
|
|
|
[NPM](https://npmjs.org) and [Yarn](https://yarnpkg.com/lang/en/docs/install/) for package management.
|
2017-09-11 22:05:01 +02:00
|
|
|
|
2018-05-18 16:41:28 +02:00
|
|
|
At the moment, we only support building on macOS and Linux, where standard GNU tools like `make` are available.
|
2017-09-11 22:05:01 +02:00
|
|
|
|
2018-05-18 16:41:28 +02:00
|
|
|
### Make Targets
|
2017-09-12 00:17:11 +02:00
|
|
|
|
2018-05-18 16:41:28 +02:00
|
|
|
To build the SDK, simply run `make` from the root directory (where this `README` lives, at `sdk/nodejs/` from the repo's
|
|
|
|
|
root). This will build the code, run tests, and install the package and its supporting artifacts.
|
2017-09-11 22:05:01 +02:00
|
|
|
|
2021-11-17 19:37:38 +01:00
|
|
|
At the moment, for local development, we install everything into `$HOME/.pulumi`. You will want this on your `$PATH`.
|
2017-09-11 22:05:01 +02:00
|
|
|
|
2019-05-06 23:00:18 +02:00
|
|
|
The tests will verify that everything works, but feel free to try running `pulumi preview` and/or `pulumi up` from
|
2017-09-22 04:18:21 +02:00
|
|
|
the `examples/minimal/` directory. Remember to run `tsc` first, since `pulumi` expects JavaScript, not TypeScript.
|
