History

Robbie McKinstry f3f54c9f9c Include SWC in the build.		2023-04-05 19:30:12 -04:00
..
asset	Use ESlint instead of TSlint (#7719 )	2021-08-10 11:31:59 -07:00
automation	Support WhoAmI in automation api for old CLI versions	2023-03-22 13:30:08 +00:00
cmd	[Intentionally incorrect:] Enable SWC for TS-Node. Have not installed TS-Noe yet.	2023-04-05 19:04:46 -04:00
dist	Fix typo in PP script	2019-08-06 17:35:52 -07:00
dynamic	Merge #11881 #11950	2023-01-24 09:14:49 +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	all: Reformat with gofumpt	2023-03-03 09:00:24 -08:00
proto	Add mapping service to converter	2023-03-24 17:09:17 +00:00
provider	[sdk/nodejs] Mark internal APIs `@internal` to filter from SDK docs	2022-09-20 11:54:06 -07:00
queryable	Use ESlint instead of TSlint (#7719 )	2021-08-10 11:31:59 -07:00
runtime	sdk: Drop date from provider conflict warning	2023-03-08 12:49:05 -08:00
tests	Merge #12374 #12397	2023-03-09 17:11:34 +00: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	[sdk/nodejs] Avoid eslint error in VS Code	2022-10-19 16:39:22 -07:00
.gitignore	ci: Pin yarn lockfile for security & dependency scanning	2022-09-21 15:35:43 -07:00
Makefile	[auto/nodejs] Test remote operations	2022-11-09 05:26:07 -08:00
README.md	adjust link text in node sdk readme (#8816 )	2022-01-28 16:45:55 -08:00
config.ts	fix: Allows for parallel pulumi programs to run in the node runtime	2022-10-13 07:15:25 -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	Make getOrganization total, default to 'organization'	2022-09-22 11:06:51 -07:00
output.ts	Add jsonParse to nodejs sdk	2022-12-28 09:30:24 +00:00
package.json	Include SWC in the build.	2023-04-05 19:30:12 -04:00
resource.ts	feat(sdk/nodejs): delegates alias computation to the engine	2022-12-15 17:23:31 -05:00
stackReference.ts	sdk/node/StackReference: Add getOutputDetails	2023-02-03 16:47:27 -08:00
tsconfig.json	sdk/node/StackReference: Add getOutputDetails	2023-02-03 16:47:27 -08:00
tsutils.ts	[sdk/nodejs] Mark internal APIs `@internal` to filter from SDK docs	2022-09-20 11:54:06 -07:00
utils.ts	fix: Allows for parallel pulumi programs to run in the node runtime	2022-10-13 07:15:25 -04:00
version.ts	Add license headers	2018-05-22 15:02:47 -07:00
yarn.lock	Include SWC in the build.	2023-04-05 19:30:12 -04: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.