History

Cyrus Najmabadi 5e89a72627 Fixup		2020-01-08 14:50:56 -08:00
..
asset	Properly mark members as @internal (#2670 )	2019-04-23 19:24:06 -07:00
cmd	Fixup	2020-01-08 14:50:56 -08:00
dist	Fix typo in PP script	2019-08-06 17:35:52 -07:00
dynamic	Break out Resource and Output into their own files (#2420 )	2019-01-31 18:08:17 -08:00
iterable	Break out Resource and Output into their own files (#2420 )	2019-01-31 18:08:17 -08:00
log	Have child resources update their parent urn to include themselves in its dependencies. (#2299 )	2019-02-21 20:18:29 -08:00
proto	generate	2020-01-08 14:09:45 -08:00
queryable	Use TypeScript's built-in `Omit` (#3597 )	2019-12-02 22:50:18 +00:00
runtime	Switch away from native grpc impl.	2020-01-08 14:09:45 -08:00
tests	Use new fully-javascript grpc lib	2020-01-08 14:10:13 -08:00
.gitignore	Add a SxS test for `@pulumi/pulumi` to help catch when we make breaking changes to core types. (#2610 )	2019-03-29 12:27:42 -07:00
config.ts	Support sxs with old outputs with sync resources only. (#3680 )	2019-12-17 19:04:09 -08:00
errors.ts	Properly mark members as @internal (#2670 )	2019-04-23 19:24:06 -07:00
index.ts	Add a helper function to easily convert async functions to sync functions (#2943 )	2019-07-16 12:12:21 -07:00
invoke.ts	remove deasync functionality from invokes	2019-12-02 12:55:50 -08:00
Makefile	Fix typing for 'Lifted<T>' to work better across versions of TS (#3658 )	2019-12-13 11:18:19 -08:00
metadata.ts	Enable unit testing for Pulumi programs (#2638 )	2019-04-16 22:20:01 -07:00
output.ts	Support sxs with old outputs with sync resources only. (#3680 )	2019-12-17 19:04:09 -08:00
package.json	Switch away from native grpc impl.	2020-01-08 14:09:45 -08:00
README.md	Update references to pulumi.io (#2979 )	2019-07-25 09:58:12 -07:00
resource.ts	Make property internal (#3682 )	2019-12-18 01:46:29 -08:00
stackReference.ts	Merge branch 'master' into features/dedeasync	2020-01-07 12:23:10 -08:00
tsconfig.json	remove deasync functionality from invokes	2019-12-02 12:55:50 -08:00
tslint.json	Fix issue with comments throwing off function/class serialization (#2438 )	2019-02-08 14:58:24 -08:00
utils.ts	fix	2020-01-07 12:43:35 -08:00
version.ts	Add license headers	2018-05-22 15:02:47 -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.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 up from the examples/minimal/ directory. Remember to run tsc first, since pulumi expects JavaScript, not TypeScript.