mirrors
/
pulumi
mirror of https://github.com/pulumi/pulumi.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pulumi/sdk/nodejs
History
Kyle Dixler 658021f5ff Add `pulumi state edit` utility. 
Fixes #13088

Adds `pulumi state edit` an experimental utility for manually editing
pulumi stack state. The command mimics the `git commit` flow by opening
the stack's state in the text editor specified by the EDITOR environment
variable and then previews the file to be saved.

There are TODO comments detailing remaining steps to un-hide `pulumi
state edit`. Namely testing round-tripping unicode.
 		2023-07-17 09:47:05 -07:00
..
asset Apply autoformat 2023-04-28 18:27:10 -04:00
automation [apitype] Add RetainOnDelete to StepEventStateMetadata 2023-06-26 12:50:39 -07:00
cmd Add `pulumi state edit` utility. 2023-07-17 09:47:05 -07:00
dist Fix typo in PP script 2019-08-06 17:35:52 -07:00
dynamic Allow dynamic providers to capture secrets 2023-06-29 15:28:31 -07:00
iterable Apply autoformat 2023-04-28 18:27:10 -04:00
log Apply autoformat 2023-04-28 18:27:10 -04:00
npm Merge #13021 #13054 2023-05-30 19:48:20 +00:00
proto [engine] Add support for source positions 2023-07-10 14:35:40 -07:00
provider [sdk/nodejs] Write port as string to avoid colorized output 2023-06-19 16:24:14 -07:00
queryable This commit safely replaces empty interfaces with type aliases. 2023-05-11 23:10:00 -04:00
runtime [sdk/*] Add support for resource source positions 2023-07-13 16:46:04 -07:00
tests [sdk/*] Add support for resource source positions 2023-07-13 16:46:04 -07:00
tests_with_mocks Add testing for async TS mocks 2023-06-01 14:13:04 +02:00
.eslintrc.js Apply autoformat 2023-04-28 18:27:10 -04:00
.gitignore ci: Pin yarn lockfile for security & dependency scanning 2022-09-21 15:35:43 -07:00
Makefile Fix makefiles 2023-05-26 11:00:45 +01:00
README.md fix some links 2023-05-19 19:39:26 -07:00
config.ts Add --secret to config set hints when needed 2023-06-22 17:25:30 +01:00
errors.ts Remove Useless Constructors. 2023-05-15 19:48:47 -04: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 Fix links outputs docs 2023-07-12 14:59:07 -07:00
package.json Merge #13278 2023-07-11 10:45:41 +00:00
resource.ts [sdk/*] Add support for resource source positions 2023-07-13 16:46:04 -07:00
rome.json Remove Useless Constructors. 2023-05-15 19:48:47 -04:00
stackReference.ts Apply autoformat 2023-04-28 18:27:10 -04: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 Apply autoformat 2023-04-28 18:27:10 -04:00
version.ts Add license headers 2018-05-22 15:02:47 -07:00
yarn.lock Merge #13278 2023-07-11 10:45:41 +00: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.