History

Robbie McKinstry 579a13a180 Finish impl of tracer setup. WIP installing modules		2022-07-20 16:55:32 -04:00
..
asset	Use ESlint instead of TSlint (#7719 )	2021-08-10 11:31:59 -07:00
automation	[auto] Add flag to show secrets (#9879 )	2022-06-24 10:00:09 -07:00
cmd	WIP adding tracing module	2022-07-20 15:13:30 -04:00
dist	Fix typo in PP script	2019-08-06 17:35:52 -07:00
dynamic	Remove sequence numbers from dynamic providers (#8849 )	2022-01-27 20:34:12 +00: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	Respond to SIGINT during plugin install (#9793 )	2022-06-09 14:57:56 -07:00
proto	Compile protobufs with "pulumi" namespace (#10074 )	2022-07-12 14:45:03 +01:00
provider	Tidy Nodejs SDK imports (#9658 )	2022-05-30 09:31:28 +01:00
queryable	Use ESlint instead of TSlint (#7719 )	2021-08-10 11:31:59 -07:00
runtime	Finish impl of tracer setup. WIP installing modules	2022-07-20 16:55:32 -04:00
tests	Update all references to pulumi so that source-map-support isn't deprecated anymore (#10032 )	2022-07-01 20:31:57 +02: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	Remove PROJECT_ROOT Make var (#9953 )	2022-06-24 10:04:40 -04:00
README.md	adjust link text in node sdk readme (#8816 )	2022-01-28 16:45:55 -08:00
config.ts	Tidy Nodejs SDK imports (#9658 )	2022-05-30 09:31:28 +01: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	Enable unit testing for Pulumi programs (#2638 )	2019-04-16 22:20:01 -07:00
output.ts	Use ESlint instead of TSlint (#7719 )	2021-08-10 11:31:59 -07:00
package.json	Finish impl of tracer setup. WIP installing modules	2022-07-20 16:55:32 -04:00
resource.ts	Fix createUrn when parent is the stack type (#10014 )	2022-06-30 16:13:04 +01:00
stackReference.ts	Tidy Nodejs SDK imports (#9658 )	2022-05-30 09:31:28 +01:00
tsconfig.json	Include invoke.ts (and its type `InvokeOptions`) in generated documentation (#9973 )	2022-06-28 15:17:38 +01:00
tslint.json	Fix issue with comments throwing off function/class serialization (#2438 )	2019-02-08 14:58:24 -08: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.