isabella232 / neon-cli

Automatically create and build Neon modules.

Neon-cli

Automatically create and build Neon modules.

Getting started

Install neon-cli as a global package:

npm install -g neon-cli

To create a new Neon project, use neon new:

neon new my-project

This will ask you a few questions and then generate a project skeleton for you. Follow the instructions from there to build and run your project!

Requirements

You'll need the following on all OSes:

• Node v4 or later;
• Rust v1.5 or later;
• multirust (only required for Neon projects that override the system default Rust).

For Mac OS X, you'll need:

• OS X 10.7 or later;
• XCode.

Commands

neon new

Creates a new Neon project skeleton.

neon new <name> [--rust|-r <toolchain>]

The name is the project name and the name of the subdirectory of the current working directory that will be created.

The optional --rust parameter allows specifying a custom toolchain (stable or nightly) to use for building the project with multirust instead of the system default Rust installation.

Get Involved

The Neon community is just getting started and there's tons of fun to be had. Come play! :)

The Rust Bridge community Slack is open to all; use the Slackin app to receive an invitation.

There's also an IRC channel at #neon on Mozilla IRC (irc.mozilla.org).

License

MIT