History

CyrusNajmabadi 19a313b628 Do not analyze user source code for required packages. We'll analyze their project.json for that. (#1612 )		2018-10-18 11:21:47 -07:00
..
asset	Make RTTI markers internal (#1479 )	2018-06-07 21:34:06 -07:00
cmd	Pass new inputs as default check return (#2037 )	2018-10-08 17:00:44 -07:00
dist	Don't set NODE_PATH in dynamic provider	2018-06-15 11:12:24 -07:00
dynamic	Reimplement refresh. (#1814 )	2018-08-22 17:52:46 -07:00
log	Expose hte ephemeral logging flag to the Nodejs sdk. (#2056 )	2018-10-12 11:09:09 -07:00
proto	Move management of root resource state to engine (#1944 )	2018-09-18 11:47:34 -07:00
runtime	Do not analyze user source code for required packages. We'll analyze their project.json for that. (#1612 )	2018-10-18 11:21:47 -07:00
tests	Do not analyze user source code for required packages. We'll analyze their project.json for that. (#1612 )	2018-10-18 11:21:47 -07:00
.gitignore	Continue to add native modules to NODE_PATH	2018-04-13 14:26:32 -07:00
config.ts	Fix requireObject docs (#1961 )	2018-09-21 07:58:14 -07:00
errors.ts	Fix rtti check. (#1983 )	2018-09-24 20:06:31 -07:00
index.ts	Expose the InvokeOptions type in the Node SDK. (#1724 )	2018-08-07 13:14:16 -07:00
invoke.ts	Pull default options from a resource's parent. (#1748 )	2018-08-10 16:18:21 -07:00
Makefile	Add a Dockerfile for the Pulumi CLI	2018-09-29 11:48:21 -07:00
metadata.ts	Add license headers	2018-05-22 15:02:47 -07:00
package.json	Switch to upath so that all paths are in unix-format (#2019 )	2018-10-03 12:06:55 -07:00
README.md	Remove Private Beta warning	2018-06-18 05:00:38 -07:00
resource.ts	Don't `unwrap` functions	2018-10-15 14:28:28 -07:00
tsconfig.json	Fix computation of the isKnown bit for an Output (when the apply function returns an Output itself). (#1974 )	2018-09-25 21:29:27 -07:00
tslint.json	Add license headers	2018-05-22 15:02:47 -07:00
version.ts	Add license headers	2018-05-22 15:02:47 -07:00
yarn.lock	Switch to upath so that all paths are in unix-format (#2019 )	2018-10-03 12:06:55 -07:00

README.md

Pulumi Node.js SDK

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

Installation

Using npm:

$ npm install --save @pulumi/pulumi

Using yarn:

$ yarn add @pulumi/pulumi

This SDK is meant for use with the Pulumi CLI. Please visit 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. We support both NPM and Yarn 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.