Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thomas-crane/nrelay-cli
A command line interface for generating and running nrelay projects.
https://github.com/thomas-crane/nrelay-cli
cli nrelay rotmg typescript
Last synced: 3 months ago
JSON representation
A command line interface for generating and running nrelay projects.
- Host: GitHub
- URL: https://github.com/thomas-crane/nrelay-cli
- Owner: thomas-crane
- License: mit
- Created: 2019-04-01T04:35:33.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-10T22:59:36.000Z (over 3 years ago)
- Last Synced: 2024-10-10T18:07:56.881Z (3 months ago)
- Topics: cli, nrelay, rotmg, typescript
- Language: TypeScript
- Size: 79.1 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# nrelay-cli
A command line interface for generating and running nrelay projects.
## Contents
+ [Install](#install)
+ [Commands](#commands)
+ [new](#new)
+ [run](#run)
+ [build](#build)
+ [eject](#eject)
+ [fix](#fix)
+ [update](#update)
## Install
```no-lang
npm install -g nrelay-cli
```
## Commands
Running nrelay with no commands will print the help information.
### new
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.
```no-lang
nrelay new my-new-project
```
Creates a new folder in the current working directory of the console called `my-new-project`.
### run
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.
```no-lang
nrelay run
```
Runs the project with no arguments.
```no-lang
nrelay run --no-update
```
Runs the project and doesn't check for any updates when starting up.
### build
The build command is simply used to build the current nrelay project. This is just an alias for `npm run compile`.
```no-lang
nrelay build
```
Builds the project.
### eject
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.
```no-lang
nrelay eject
```
Ejects the nrelay project. An ejected project can be run by using
```no-lang
node index
```
Instead of the usual run command (the run command will still work, though).
### fix
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.
```no-lang
nrelay fix
```
Adds any missing files which are required by the CLI.
### update
The update command updates a project's nrelay dependency to the latest version. This is an alias for `npm install --save nrelay@next`.
```no-lang
nrelay update
```
Updates the nrelay dependency of the project.