pulumi/sdk/nodejs/README.md

# Pulumi Node.js SDK

:warning: **Pulumi is in private beta.  This package may not work unless you are already participating.
Please visit [pulumi.com](https://pulumi.com/) to register for access.**

The Pulumi Node.js SDK lets you write cloud programs in JavaScript.

## Installation

Using npm:

```bash
$ npm install --save @pulumi/pulumi
```

Using yarn:

```bash
$ yarn add @pulumi/pulumi
```

This SDK is meant for use with the Pulumi CLI.  Please visit [pulumi.io](https://pulumi.io) for
installation instructions.

## Building and Testing

For anybody who wants to build from source, here is how you do it.

### Prerequisites

This SDK uses Node.js and we support the Active LTS and Current releases, as defined by
[this table](https://github.com/nodejs/Release#release-schedule).  We support both [NPM](https://npmjs.org) and
[Yarn](https://yarnpkg.com/lang/en/docs/install/) for package management.

At the moment, we only support building on macOS and Linux, where standard GNU tools like `make` are available.

### Make Targets

The first time you build, run `make ensure` to install and prepare native plugins for V8:

    $ make ensure

This is only necessary if you intend to produce a build that is capable of running older versions of the SDK
contained in this directory.  If you do intend to do this, you must have node `6.10.2` installed.

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.

At the moment, for local development, we install everything into `/opt/pulumi`.  You will want this on your `$PATH`.

The tests will verify that everything works, but feel free to try running `pulumi preview` and/or `pulumi update` from
the `examples/minimal/` directory.  Remember to run `tsc` first, since `pulumi` expects JavaScript, not TypeScript.
Update the README 2018-05-18 16:41:28 +02:00			`# Pulumi Node.js SDK`
Clean up the READMEs 2017-09-11 22:05:01 +02:00
Prepare package for public publishing This adds a warning to the top of the README.md and adds a license to the package.json (to eliminate the associated warning). 2018-05-18 20:20:51 +02:00			`:warning: **Pulumi is in private beta. This package may not work unless you are already participating.`
Fix pulumi.com hyperlink in README 2018-05-18 20:22:42 +02:00			`Please visit [pulumi.com](https://pulumi.com/) to register for access.**`
Prepare package for public publishing This adds a warning to the top of the README.md and adds a license to the package.json (to eliminate the associated warning). 2018-05-18 20:20:51 +02:00
Update the README 2018-05-18 16:41:28 +02:00			`The Pulumi Node.js SDK lets you write cloud programs in JavaScript.`
Clean up the READMEs 2017-09-11 22:05:01 +02:00
Update the README 2018-05-18 16:41:28 +02:00			`## Installation`
Clean up the READMEs 2017-09-11 22:05:01 +02:00
Update the README 2018-05-18 16:41:28 +02:00			`Using npm:`
Clean up the READMEs 2017-09-11 22:05:01 +02:00
Update the README 2018-05-18 16:41:28 +02:00			```bash
			`$ npm install --save @pulumi/pulumi`
			```

			`Using yarn:`

			```bash
			`$ yarn add @pulumi/pulumi`
			```

s/docs.pulumi.com/pulumi.io/g The docs website is moving to https://pulumi.io from https://docs.pulumi.com 2018-06-11 20:45:17 +02:00			`This SDK is meant for use with the Pulumi CLI. Please visit [pulumi.io](https://pulumi.io) for`
Update the README 2018-05-18 16:41:28 +02:00			`installation instructions.`
Clean up the READMEs 2017-09-11 22:05:01 +02:00
Update the README 2018-05-18 16:41:28 +02:00			`## Building and Testing`
Clean up the READMEs 2017-09-11 22:05:01 +02:00
Update the README 2018-05-18 16:41:28 +02:00			`For anybody who wants to build from source, here is how you do it.`
Clean up the READMEs 2017-09-11 22:05:01 +02:00
Update the README 2018-05-18 16:41:28 +02:00			`### Prerequisites`

			`This SDK uses Node.js and we support the Active LTS and Current releases, as defined by`
			`[this table](https://github.com/nodejs/Release#release-schedule). We support both [NPM](https://npmjs.org) and`
			`[Yarn](https://yarnpkg.com/lang/en/docs/install/) for package management.`
Clean up the READMEs 2017-09-11 22:05:01 +02:00
Update the README 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.
Clean up the READMEs 2017-09-11 22:05:01 +02:00
Update the README 2018-05-18 16:41:28 +02:00			`### Make Targets`
Add instructions for make configure And also move the Node.js SDK-specific parts into the sdk/nodejs/ directory. 2017-09-12 00:17:11 +02:00
Update the README 2018-05-18 16:41:28 +02:00			The first time you build, run `make ensure` to install and prepare native plugins for V8:

			`$ make ensure`
Add instructions for make configure And also move the Node.js SDK-specific parts into the sdk/nodejs/ directory. 2017-09-12 00:17:11 +02:00
CI cleanup for various Node versions (#1233) * Run Windows CI against node v8.10 * Update READMEs 2018-04-19 22:44:47 +02:00			`This is only necessary if you intend to produce a build that is capable of running older versions of the SDK`
Update the README 2018-05-18 16:41:28 +02:00			contained in this directory. If you do intend to do this, you must have node `6.10.2` installed.
Add instructions for make configure And also move the Node.js SDK-specific parts into the sdk/nodejs/ directory. 2017-09-12 00:17:11 +02:00
Update the README 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.`
Clean up the READMEs 2017-09-11 22:05:01 +02:00
Update the README 2018-05-18 16:41:28 +02:00			At the moment, for local development, we install everything into `/opt/pulumi`. You will want this on your `$PATH`.
Clean up the READMEs 2017-09-11 22:05:01 +02:00
`push` is dead; long live `update`. After discussion with Joe and Luke, we've decided to use `update` instead of `push` as it more intuitively fits the operation being performed. 2017-09-23 02:23:40 +02:00			The tests will verify that everything works, but feel free to try running `pulumi preview` and/or `pulumi update` from
Rename pulumi-fabric to pulumi This includes a few changes: * The repo name -- and hence the Go modules -- changes from pulumi-fabric to pulumi. * The Node.js SDK package changes from @pulumi/pulumi-fabric to just pulumi. * The CLI is renamed from lumi to pulumi. 2017-09-22 04:18:21 +02:00			the `examples/minimal/` directory. Remember to run `tsc` first, since `pulumi` expects JavaScript, not TypeScript.