Skip to main content
Version: 6.x (latest)

Quickstart local demo

Try N|Solid without installing it. The N|Solid Quickstart package downloads a temporary copy of the N|Solid Runtime, runs a demo application or your own application with it, and connects it to your N|Solid SaaS account so you can explore the N|Solid Console right away.

note

This quickstart requires Node.js and npm on your system. If you don't have them, skip ahead to the local installation instructions and install N|Solid directly.

Check that npx is available​

npx runs command-line tools published to the npm registry. It downloads the tool to a cache and runs it locally. npx ships with npm 5.2 and later. If npx is missing, update npm:

npm install -g npm

Get your N|Solid SaaS token​

Sign in to NodeSource Accounts and copy your NSOLID_SAAS token.

Copying your NSOLID_SAAS key

Run the demo application​

Run nsolid-quickstart with npx and pass your token with --saas. Put the token in quotes, because it can contain characters such as % that your shell may interpret:

npx nsolid-quickstart --saas "<your-saas-token>" --demo

Run your own application​

To run your own application, either run one of the scripts defined in your package.json or name the file to execute.

To run an npm script (npm run start in this example):

npx nsolid-quickstart --saas "<your-saas-token>" --npm start

To run a specific file:

npx nsolid-quickstart --saas "<your-saas-token>" --exec index.js

Choose a Node.js version​

By default, the quickstart runs the Node.js 22 (Jod) line of N|Solid. To run the Node.js 24 (Krypton) line, add --lts krypton:

npx nsolid-quickstart --saas "<your-saas-token>" --exec index.js --lts krypton

Other options:

  • --version: run a specific N|Solid release.
  • --remote: connect to a self-hosted N|Solid Console instead of N|Solid SaaS. Pass the value you would use for NSOLID_COMMAND.

To delete the cached N|Solid downloads, run npx nsolid-quickstart clean.

NodeSource Support