@noreajs/cli

@noreajs/cli

Norea.js command lines for components and applications creation

• Usage
• Commands

• Usage
• Commands

Usage

$ npm install -g @noreajs/cli
$ norea COMMAND
running command...
$ norea (-v|--version|version)
@noreajs/cli/0.1.1 win32-x64 node-v16.9.1
$ norea --help [COMMAND]
USAGE
  $ norea COMMAND
...

$ npm install -g @noreajs/cli
$ norea COMMAND
running command...
$ norea (-v|--version|version)
@noreajs/cli/0.0.1 win32-x64 node-v12.16.2
$ norea --help [COMMAND]
USAGE
  $ norea COMMAND
...

Commands

• norea autocomplete [SHELL]
• norea hello
• norea help [COMMAND]
• norea make:controller NAME
• norea make:interface INTERFACENAME
• norea make:middleware MIDDLEWARENAME
• norea make:model MODELNAME
• norea make:provider PROVIDERNAME
• norea make:route ROUTENAME
• norea new APPNAME
• norea plugins
• norea plugins:install PLUGIN...
• norea plugins:link PLUGIN
• norea plugins:uninstall PLUGIN...
• norea plugins:update
• norea start
• norea update [CHANNEL]

norea autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ norea autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ norea autocomplete
  $ norea autocomplete bash
  $ norea autocomplete zsh
  $ norea autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

norea hello

describe the command here

USAGE
  $ norea hello

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ norea hello

See code: src\commands\hello.ts

norea help [COMMAND]

display help for norea

USAGE
  $ norea help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

norea make:controller NAME

create a new controller

USAGE
  $ norea make:controller NAME

ARGUMENTS
  NAME  controller name

OPTIONS
  -h, --help                       show CLI help
  -n, --noActions                  not include controller actions (index, edit, show, delete, create)
  -s, --separate                   separate the model's interface
  --middleware                     include a middleware, generate if not exist.
  --middlewareName=middlewareName  include a middleware with the given name, generate if not exist.
  --model                          include a model, generate if not exist.
  --modelName=modelName            include a model with the given name, generate if not exist.
  --provider                       include a provider, generate if not exist.
  --providerName=providerName      include a provider with the given name, generate if not exist.

See code: src\commands\make\controller.ts

norea make:interface INTERFACENAME

create a new interface

USAGE
  $ norea make:interface INTERFACENAME

ARGUMENTS
  INTERFACENAME  interface name

OPTIONS
  -h, --help        show CLI help
  -s, --softDelete  add deletedAt attribute in the model's interface
  -t, --timestamps  add createdAt and updatedAt attributes in the model's interface

See code: src\commands\make\interface.ts

norea make:middleware MIDDLEWARENAME

create a middleware

USAGE
  $ norea make:middleware MIDDLEWARENAME

ARGUMENTS
  MIDDLEWARENAME  middleware name

OPTIONS
  -h, --help  show CLI help

See code: src\commands\make\middleware.ts

norea make:model MODELNAME

create a new model

USAGE
  $ norea make:model MODELNAME

ARGUMENTS
  MODELNAME  model name

OPTIONS
  -S, --softDelete  add deletedAt attribute in the model's interface
  -h, --help        show CLI help
  -s, --separate    separate the model's interface
  -t, --timestamps  add createdAt and updatedAt attributes in the model's interface

See code: src\commands\make\model.ts

norea make:provider PROVIDERNAME

create a new provider

USAGE
  $ norea make:provider PROVIDERNAME

ARGUMENTS
  PROVIDERNAME  provider name

OPTIONS
  -h, --help  show CLI help

See code: src\commands\make\provider.ts

norea make:route ROUTENAME

create a route file

USAGE
  $ norea make:route ROUTENAME

ARGUMENTS
  ROUTENAME  route name

OPTIONS
  -h, --help  show CLI help

See code: src\commands\make\route.ts

norea new APPNAME

create a new norea.js application (API)

USAGE
  $ norea new APPNAME

ARGUMENTS
  APPNAME  application name

OPTIONS
  -d, --dbStrategy=mongoose|sequelize   [default: mongoose] mongoose for MongoDB database and sequelize ORM for
                                        Postgres, MySQL, MariaDB, SQLite and Microsoft SQL Server database

  -f, --force

  -h, --help                            show CLI help

  -p, --package=npm|yarn                [default: npm] package manager to use

  -t, --template=typescript|javascript  [default: typescript] project template

  -v, --version=version                 Release version (ex: v1.0.1)

See code: src\commands\new.ts

norea plugins

list installed plugins

USAGE
  $ norea plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ norea plugins

See code: @oclif/plugin-plugins

norea plugins:install PLUGIN...

installs a plugin into the CLI

USAGE
  $ norea plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  plugin to install

OPTIONS
  -f, --force    yarn install with force flag
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command 
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in 
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ norea plugins:add

EXAMPLES
  $ norea plugins:install myplugin 
  $ norea plugins:install https://github.com/someuser/someplugin
  $ norea plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

norea plugins:link PLUGIN

links a plugin into the CLI for development

USAGE
  $ norea plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' 
  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLE
  $ norea plugins:link myplugin

See code: @oclif/plugin-plugins

norea plugins:uninstall PLUGIN...

removes a plugin from the CLI

USAGE
  $ norea plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

ALIASES
  $ norea plugins:unlink
  $ norea plugins:remove

See code: @oclif/plugin-plugins

norea plugins:update

update installed plugins

USAGE
  $ norea plugins:update

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

See code: @oclif/plugin-plugins

norea start

start application

USAGE
  $ norea start

OPTIONS
  -d, --development                       development environnement
  -e, --env=local|production|development  application environnement
  -h, --help                              show CLI help
  -l, --local                             local environnement
  -p, --production                        production environnement
  --port=port                             application port

See code: src\commands\start.ts

norea update [CHANNEL]

update the norea CLI

USAGE
  $ norea update [CHANNEL]

See code: @oclif/plugin-update

• norea autocomplete [SHELL]
• norea hello
• norea help [COMMAND]
• norea make:controller NAME
• norea make:interface INTERFACENAME
• norea make:middleware MIDDLEWARENAME
• norea make:model MODELNAME
• norea make:provider PROVIDERNAME
• norea make:route ROUTENAME
• norea new APPNAME
• norea plugins
• norea plugins:install PLUGIN...
• norea plugins:link PLUGIN
• norea plugins:uninstall PLUGIN...
• norea plugins:update
• norea start [FILE]
• norea update [CHANNEL]

norea autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ norea autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ norea autocomplete
  $ norea autocomplete bash
  $ norea autocomplete zsh
  $ norea autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

norea hello

describe the command here

USAGE
  $ norea hello

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ norea hello

See code: src\commands\hello.ts

norea help [COMMAND]

display help for norea

USAGE
  $ norea help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

norea make:controller NAME

create a new controller

USAGE
  $ norea make:controller NAME

ARGUMENTS
  NAME  controller name

OPTIONS
  -h, --help                       show CLI help
  -n, --noActions                  not include controller actions (index, edit, show, delete, create)
  -s, --separate                   separate the model's interface
  --middleware                     include a middleware, generate if not exist.
  --middlewareName=middlewareName  include a middleware with the given name, generate if not exist.
  --model                          include a model, generate if not exist.
  --modelName=modelName            include a model with the given name, generate if not exist.
  --provider                       include a provider, generate if not exist.
  --providerName=providerName      include a provider with the given name, generate if not exist.

See code: src\commands\make\controller.ts

norea make:interface INTERFACENAME

create a new interface

USAGE
  $ norea make:interface INTERFACENAME

ARGUMENTS
  INTERFACENAME  interface name

OPTIONS
  -h, --help  show CLI help

See code: src\commands\make\interface.ts

norea make:middleware MIDDLEWARENAME

create a middleware

USAGE
  $ norea make:middleware MIDDLEWARENAME

ARGUMENTS
  MIDDLEWARENAME  middleware name

OPTIONS
  -h, --help  show CLI help

See code: src\commands\make\middleware.ts

norea make:model MODELNAME

create a new model

USAGE
  $ norea make:model MODELNAME

ARGUMENTS
  MODELNAME  model name

OPTIONS
  -h, --help      show CLI help
  -s, --separate  separate the model's interface

See code: src\commands\make\model.ts

norea make:provider PROVIDERNAME

create a new provider

USAGE
  $ norea make:provider PROVIDERNAME

ARGUMENTS
  PROVIDERNAME  provider name

OPTIONS
  -h, --help  show CLI help

See code: src\commands\make\provider.ts

norea make:route ROUTENAME

create a route file

USAGE
  $ norea make:route ROUTENAME

ARGUMENTS
  ROUTENAME  route name

OPTIONS
  -h, --help  show CLI help

See code: src\commands\make\route.ts

norea new APPNAME

create a new norea.js application (API)

USAGE
  $ norea new APPNAME

ARGUMENTS
  APPNAME  application name

OPTIONS
  -d, --dbStrategy=mongoose|sequelize   [default: mongoose] mongoose for MongoDB database and sequelize ORM for
                                        Postgres, MySQL, MariaDB, SQLite and Microsoft SQL Server database

  -f, --force

  -h, --help                            show CLI help

  -p, --package=npm|yarn                [default: npm] package manager to use

  -t, --template=typescript|javascript  [default: typescript] project template

See code: src\commands\new.ts

norea plugins

list installed plugins

USAGE
  $ norea plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ norea plugins

See code: @oclif/plugin-plugins

norea plugins:install PLUGIN...

installs a plugin into the CLI

USAGE
  $ norea plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  plugin to install

OPTIONS
  -f, --force    yarn install with force flag
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command 
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in 
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ norea plugins:add

EXAMPLES
  $ norea plugins:install myplugin 
  $ norea plugins:install https://github.com/someuser/someplugin
  $ norea plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

norea plugins:link PLUGIN

links a plugin into the CLI for development

USAGE
  $ norea plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' 
  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLE
  $ norea plugins:link myplugin

See code: @oclif/plugin-plugins

norea plugins:uninstall PLUGIN...

removes a plugin from the CLI

USAGE
  $ norea plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

ALIASES
  $ norea plugins:unlink
  $ norea plugins:remove

See code: @oclif/plugin-plugins

norea plugins:update

update installed plugins

USAGE
  $ norea plugins:update

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

See code: @oclif/plugin-plugins

norea start [FILE]

describe the command here

USAGE
  $ norea start [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src\commands\start.ts

norea update [CHANNEL]

update the norea CLI

USAGE
  $ norea update [CHANNEL]

See code: @oclif/plugin-update