History

Robbie McKinstry 14dcf2ebe4 Fix lint issues		2022-09-15 07:27:44 -04:00
..
asset	Use ESlint instead of TSlint (#7719 )	2021-08-10 11:31:59 -07:00
automation	[nodejs/auto] Fix incremental behavior of onStdout (#10678 )	2022-09-12 12:41:08 -04:00
cmd	Fix lint issues	2022-09-15 07:27:44 -04:00
dist	Fix typo in PP script	2019-08-06 17:35:52 -07:00
dynamic	Avoid importing typescript unless necessary (#10185 )	2022-07-20 17:38:55 -04:00
iterable	Use ESlint instead of TSlint (#7719 )	2021-08-10 11:31:59 -07:00
log	Use ESlint instead of TSlint (#7719 )	2021-08-10 11:31:59 -07:00
npm	ci: Prevent yarn mutex timeout by single-threading yarn commands	2022-09-14 10:07:21 -07:00
proto	Add getOrganization to nodejs and python (#10504 )	2022-08-31 10:33:29 +01:00
provider	Add getOrganization to nodejs and python (#10504 )	2022-08-31 10:33:29 +01:00
queryable	Use ESlint instead of TSlint (#7719 )	2021-08-10 11:31:59 -07:00
runtime	Move tracing module into cmd, since it should not be part of the library code.	2022-09-15 07:26:52 -04:00
tests	Relax assert about num of onOutput calls (#10683 )	2022-09-12 13:03:25 -07:00
tests_with_mocks	[sdk/{nodejs,python}] Fix errors when testing remote components with mocks (#8053 )	2021-09-24 06:08:13 -07:00
.eslintrc.js	ci: fix sxs test	2022-03-06 14:45:26 -08:00
.gitignore	[cli, testing, github] Gather code coverage data in CI. (#8260 )	2021-11-30 17:24:01 -08:00
Makefile	ci: Enable robust retries on tests	2022-09-14 12:19:09 -07:00
README.md	adjust link text in node sdk readme (#8816 )	2022-01-28 16:45:55 -08:00
config.ts	Avoid importing typescript unless necessary (#10185 )	2022-07-20 17:38:55 -04:00
errors.ts	Use ESlint instead of TSlint (#7719 )	2021-08-10 11:31:59 -07:00
index.ts	Removing x namespace from go/python/nodejs automation packages (#6518 )	2021-04-14 19:32:18 +01:00
invoke.ts	[sdk/nodejs] Add pluginServerURL (#8698 )	2022-01-10 15:54:41 -08:00
metadata.ts	Add getOrganization to nodejs and python (#10504 )	2022-08-31 10:33:29 +01:00
output.ts	Avoid importing typescript unless necessary (#10185 )	2022-07-20 17:38:55 -04:00
package.json	Make tracing conditional. Add gRPC instrumentation.	2022-09-15 07:26:52 -04:00
resource.ts	Avoid importing typescript unless necessary (#10185 )	2022-07-20 17:38:55 -04:00
stackReference.ts	Tidy Nodejs SDK imports (#9658 )	2022-05-30 09:31:28 +01:00
tsconfig.json	Move tracing module into cmd, since it should not be part of the library code.	2022-09-15 07:26:52 -04:00
tsutils.ts	Avoid importing typescript unless necessary (#10185 )	2022-07-20 17:38:55 -04:00
utils.ts	Tidy Nodejs SDK imports (#9658 )	2022-05-30 09:31:28 +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. Visit Pulumi's Download & Install to install the CLI.

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 any of the Current, Active and Maintenance LTS versions. 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

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 $HOME/.dev-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.