History

Luke Hoban 858e321110 Make RTTI markers internal (#1479 ) Fixes #1477.		2018-06-07 21:34:06 -07:00
..
asset	Make RTTI markers internal (#1479 )	2018-06-07 21:34:06 -07:00
cmd	Suggest `npm run build` instead of `npm build` (#1460 )	2018-06-04 15:27:29 -07:00
dist	Invoke node directly from the language host	2018-05-02 11:16:58 -07:00
dynamic	Compute required packages during closure serialization (#1457 )	2018-06-03 21:55:37 -07:00
log	Add license headers	2018-05-22 15:02:47 -07:00
proto	Add an ID property to ReadResponse (#1145 )	2018-04-10 12:58:50 -07:00
runtime	Make RTTI markers internal (#1479 )	2018-06-07 21:34:06 -07:00
tests	Compute required packages during closure serialization (#1457 )	2018-06-03 21:55:37 -07:00
.gitignore	Continue to add native modules to NODE_PATH	2018-04-13 14:26:32 -07:00
config.ts	Add license headers	2018-05-22 15:02:47 -07:00
errors.ts	Make RTTI markers internal (#1479 )	2018-06-07 21:34:06 -07:00
index.ts	Add license headers	2018-05-22 15:02:47 -07:00
Makefile	Stop including native serialization modules	2018-06-04 14:27:01 -07:00
metadata.ts	Add license headers	2018-05-22 15:02:47 -07:00
package.json	Update gRPC to 1.12.2	2018-05-30 15:42:10 -07:00
README.md	Fix pulumi.com hyperlink in README	2018-05-18 11:22:42 -07:00
resource.ts	Make RTTI markers internal (#1479 )	2018-06-07 21:34:06 -07:00
tsconfig.json	Support async function serialization. (#1311 )	2018-05-03 12:25:52 -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	Update gRPC to 1.12.2	2018-05-30 15:42:10 -07:00

README.md

Pulumi Node.js SDK

⚠️ Pulumi is in private beta. This package may not work unless you are already participating. Please visit pulumi.com to register for access.

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 docs.pulumi.com 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.