Getting Started

This guide will help you get your system set up for building Neon projects. If you already have everything installed and are looking to write your first Neon code, try the Hello, World! guide.

Install Node

Neon requires Node.js and supports all versions since the most recent LTS release. If you don't already have Node.js installed, or don't have a supported version, go to the Node.js web site for installation instructions.

Install Rust

Neon requires Rust for development and supports all versions of Rust since 1.15. If you don't already have Rust installed, or don't have a supported version, go to the Rust web site for installation instructions.

Install Node Build Tools

Neon depends on Node's plugin build tools, which have a few additional system requirements. These dependencies have different installation steps on different operating systems.

The development dependencies for macOS are:

  • Python 2.7 (Python 3 is not supported)
  • Xcode
  • Install the Command Line Tools via Xcode under the menu Xcode → Preferences → Downloads.

Install the Neon CLI

Finally, use npm to install the Neon command-line toolchain.

npm install --global neon-cli
# OR
yarn global add neon-cli

You can verify your Neon installation by running

neon version

from a shell, which should print out the version of Neon you just installed.