History

Lee Briggs 8c314ec39a Add brew make targets to sdk makefiles		2020-05-13 20:42:01 -07:00
..
asset	Mark internal APIs `@internal` to filter from API docs (#3809 )	2020-01-26 09:06:35 -08:00
cmd	remove unneeded types	2020-04-23 17:58:17 -07:00
dist	Fix typo in PP script	2019-08-06 17:35:52 -07:00
dynamic	Fixed 'transacational' misspelling.	2020-01-13 10:45:07 -08:00
iterable	Break out Resource and Output into their own files (#2420 )	2019-01-31 18:08:17 -08:00
log	Mark internal APIs `@internal` to filter from API docs (#3809 )	2020-01-26 09:06:35 -08:00
proto	Breaking changes due to Feature 2.0 work	2020-04-14 09:30:25 +01:00
queryable	Use TypeScript's built-in `Omit` (#3597 )	2019-12-02 22:50:18 +00:00
runtime	Allows conditional dependencies and Resources from apply (#4446 )	2020-05-08 17:57:08 -07:00
tests	Avoid TS compiler error (#4572 )	2020-05-05 14:22:29 -07: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	Mark internal APIs `@internal` to filter from API docs (#3809 )	2020-01-26 09:06:35 -08:00
errors.ts	Mark internal APIs `@internal` to filter from API docs (#3809 )	2020-01-26 09:06:35 -08: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	Breaking changes due to Feature 2.0 work	2020-04-14 09:30:25 +01:00
Makefile	Add brew make targets to sdk makefiles	2020-05-13 20:42:01 -07:00
metadata.ts	Enable unit testing for Pulumi programs (#2638 )	2019-04-16 22:20:01 -07:00
output.ts	Do not allocate outputs for nested prompt values. (#3851 )	2020-02-04 19:21:37 -08:00
package.json	Breaking changes due to Feature 2.0 work	2020-04-14 09:30:25 +01:00
README.md	Update references to pulumi.io (#2979 )	2019-07-25 09:58:12 -07:00
resource.ts	Mark internal APIs `@internal` to filter from API docs (#3809 )	2020-01-26 09:06:35 -08:00
stackReference.ts	Breaking changes due to Feature 2.0 work	2020-04-14 09:30:25 +01:00
tsconfig.json	Breaking changes due to Feature 2.0 work	2020-04-14 09:30:25 +01:00
tslint.json	Fix issue with comments throwing off function/class serialization (#2438 )	2019-02-08 14:58:24 -08:00
utils.ts	Breaking changes due to Feature 2.0 work	2020-04-14 09:30:25 +01: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.