node README

The project's README from github.com/nodejs/node. As one markdown file: README.md.

Node.js

Node.js is an open-source, cross-platform JavaScript runtime environment.

For information on using Node.js, see the [Node.js website][].

The Node.js project uses an open governance model. The [OpenJS Foundation][] provides support for the project.

Contributors are expected to act in a collaborative manner to move the project forward. We encourage the constructive exchange of contrary opinions and compromise. The TSC reserves the right to limit or block contributors who repeatedly act in ways that discourage, exhaust, or otherwise negatively affect other participants.

This project has a [Code of Conduct][].

Table of contents

Support

Looking for help? Check out the instructions for getting support.

Release types

Current and LTS releases follow semantic versioning. A member of the Release Team signs each Current and LTS release. For more information, see the Release README.

Download

Binaries, installers, and source tarballs are available at https://nodejs.org/en/download/.

Current and LTS releases

https://nodejs.org/download/release/

The latest directory is an alias for the latest Current release. The latest-codename directory is an alias for the latest release from an LTS line. For example, the latest-hydrogen directory contains the latest Hydrogen (Node.js 18) release.

Nightly releases

https://nodejs.org/download/nightly/

Each directory and filename includes the version (e.g., v22.0.0), followed by the UTC date (e.g., 20240424 for April 24, 2024), and the short commit SHA of the HEAD of the release (e.g., ddd0a9e494). For instance, a full directory name might look like v22.0.0-nightly20240424ddd0a9e494.

API documentation

Documentation for the latest Current release is at https://nodejs.org/api/. Version-specific documentation is available in each release directory in the docs subdirectory. Version-specific documentation is also at https://nodejs.org/download/docs/.

Verifying binaries

Download directories contain a SHASUMS256.txt.asc file with SHA checksums for the files and the releaser PGP signature.

You can get a trusted keyring from nodejs/release-keys, e.g. using curl:

curl -fsLo "/path/to/nodejs-keyring.kbx" "https://github.com/nodejs/release-keys/raw/HEAD/gpg/pubring.kbx"

Alternatively, you can import the releaser keys in your default keyring, see Release keys for commands on how to do that.

Then, you can verify the files you've downloaded locally (if you're using your default keyring, pass --keyring="${GNUPGHOME:-~/.gnupg}/pubring.kbx"):

curl -fsO "https://nodejs.org/dist/${VERSION}/SHASUMS256.txt.asc" \
&& gpgv --keyring="/path/to/nodejs-keyring.kbx" --output SHASUMS256.txt < SHASUMS256.txt.asc \
&& shasum --check SHASUMS256.txt --ignore-missing

Building Node.js

See BUILDING.md for instructions on how to build Node.js from source and a list of supported platforms.

Security

For information on reporting security vulnerabilities in Node.js, see SECURITY.md.

Contributing to Node.js

Current project team members

For information about the governance of the Node.js project, see GOVERNANCE.md.

TSC (Technical Steering Committee)

TSC voting members

TSC regular members

TSC emeriti members

TSC emeriti members

Collaborators

node (nodejs/node)

Searching Database…

122.4K ·GitHub
Node
What is this?Node.js is an open-source, cross-platform JavaScript runtime environment that lets you run JavaScript code outside a browser, typically for servers and command-line tools.
Is this a framework or the JS engine itself?It's the runtime environment itself (built around V8), not a web framework — frameworks like Express run on top of it.
How do I get Node.js running?Grab a prebuilt binary, installer, or source tarball for your OS from the Node.js website, or build it from source yourself.
Will my code break when I upgrade Node?Node releases a new major version every 6 months (April and October) and Current releases can include breaking changes; only even-numbered majors become LTS with 12 months of active support plus 18 months of maintenance.
Which operating systems does it run on?Node.js is built and supported on Linux, macOS, and Windows.
What's the difference between a Current release and an LTS release?Current is the actively developed branch for the latest major version and can include breaking changes; LTS releases are the even-numbered majors chosen for long-term stability, getting 12 months of active support followed by 18 months of maintenance-only updates.
Are there nightly builds if I want bleeding-edge code?Yes, nightly builds are compiled every 24 hours from the Current branch whenever there are changes, but the project warns to use them with caution.
What are similar projects?node-gyp, chokidar, deno, tsx, ts-node, ava, core-js, joi
Which topics is it in?js, runtime, node, ci, backend, npm, server, nodejs, javascript, python, cross-platform, developer-tools
Creator
nodejs
Size
1.6 GB
Stars
122.4K
Updated
CommitOct 17Releasev26.12.0Oct 14
Age
11y
Commits · 90 Days