A command line interface for generating and running nrelay projects.

• Install
• Commands
  • new
  • run
  • build
  • eject
  • fix
  • update

npm install -g nrelay-cli

Running nrelay with no commands will print the help information.

The new command can be used to generate a new nrelay project. It requires a single argument which is the name of the project that will be generated. The new project will be created in a folder in the current working directory of the console.

nrelay new my-new-project

Creates a new folder in the current working directory of the console called my-new-project.

The run command is used to actually run an nrelay project. Any arguments which are provided will be passed on to the nrelay runtime which is created.

nrelay run

Runs the project with no arguments.

nrelay run --no-update

Runs the project and doesn't check for any updates when starting up.

The build command is simply used to build the current nrelay project. This is just an alias for npm run compile.

nrelay build

Builds the project.

The eject command can be used to modify an existing nrelay project such that it can be run independently of the CLI. This command is extremely useful when you intend to host an nrelay project, since it removes the dependency on the CLI.

nrelay eject

Ejects the nrelay project. An ejected project can be run by using

node index

Instead of the usual run command (the run command will still work, though).

The fix command can be used to add any files which are usually present in an nrelay project, but are missing. For example, if the .nrelay file was deleted accidentally, this will cause the CLI to think that the folder is not actually an nrelay project. Running nrelay fix will replace the .nrelay file so that the project can be run again.

nrelay fix

Adds any missing files which are required by the CLI.

The update command updates a project's nrelay dependency to the latest version. This is an alias for npm install --save nrelay@next.

nrelay update

Updates the nrelay dependency of the project.