@envuso/cli

Envuso CLI

Envuso CLI, make a project, generate framework files etc

• Usage
• Commands

Usage

$ npm install -g @envuso/cli
$ envuso COMMAND
running command...
$ envuso (-v|--version|version)
@envuso/cli/0.1.31 darwin-arm64 node-v16.6.0
$ envuso --help [COMMAND]
USAGE
  $ envuso COMMAND
...

Commands

• envuso autocomplete [SHELL]
• envuso build
• envuso db:reset
• envuso db:reset-collection NAME
• envuso db:seed
• envuso generate-app-key
• envuso help [COMMAND]
• envuso list
• envuso make:controller NAME
• envuso make:dto NAME
• envuso make:middleware NAME
• envuso make:model NAME
• envuso make:policy NAME
• envuso make:resource NAME
• envuso make:socket-channel-listener NAME
• envuso new

envuso autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ envuso autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

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

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

See code: @oclif/plugin-autocomplete

envuso build

Build envuso

USAGE
  $ envuso build

OPTIONS
  -h, --help   show CLI help
  -w, --watch  Runs the compiler in watch mode. Any changes will trigger a re-build.

EXAMPLES
  $ envuso build
  $ envuso build --watch

See code: lib/commands/build/index.js

envuso db:reset

Reset your database

USAGE
  $ envuso db:reset

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ envuso db:reset

See code: lib/commands/db/reset.js

envuso db:reset-collection NAME

Reset a collection in your database

USAGE
  $ envuso db:reset-collection NAME

ARGUMENTS
  NAME  The name of the collection you want to reset

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ envuso db:reset-collection users

See code: lib/commands/db/reset-collection.js

envuso db:seed

Run your database seeders

USAGE
  $ envuso db:seed

OPTIONS
  -h, --help  show CLI help
  --fresh     If specified, this will drop your collection before running the seeder.

EXAMPLES
  $ envuso db:seed
  $ envuso db:seed --fresh

See code: lib/commands/db/seed.js

envuso generate-app-key

Generate a new app encryption key

USAGE
  $ envuso generate-app-key

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ envuso generate-app-key

See code: lib/commands/generate-app-key.js

envuso help [COMMAND]

display help for envuso

USAGE
  $ envuso help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

envuso list

List all commands

USAGE
  $ envuso list

EXAMPLE
  $ envuso list

See code: lib/commands/list.js

envuso make:controller NAME

Create a controller

USAGE
  $ envuso make:controller NAME

ARGUMENTS
  NAME  Set a name for your controller(Does not need to contain "Controller" this will be automatically added.)

OPTIONS
  -f, --force        Force create the controller, even if it exists.
  -h, --help         show CLI help
  -m, --model=model  Create a resource controller using your model
  -r, --resource     Create a resource controller(Controller using GET, PUT, POST, PATCH, DELETE)

EXAMPLES
  $ envuso make:controller User
  $ envuso make:controller User --resource
  $ envuso make:controller User --resource --model=User

See code: lib/commands/make/controller.js

envuso make:dto NAME

Create a data transfer object

USAGE
  $ envuso make:dto NAME

ARGUMENTS
  NAME  Set a name for your dto(Does not need to contain "DataTransferObject" this will be automatically added.)

OPTIONS
  -f, --force  Force create the dto, even if it exists.
  -h, --help   show CLI help

EXAMPLE
  $ envuso make:dto LoginInformation

See code: lib/commands/make/dto.js

envuso make:middleware NAME

Create a middleware

USAGE
  $ envuso make:middleware NAME

ARGUMENTS
  NAME  Set a name for your middleware(Does not need to contain "Middleware" this will be automatically added.)

OPTIONS
  -f, --force  Force create the middleware, even if it exists.
  -h, --help   show CLI help

EXAMPLE
  $ envuso make:middleware User

See code: lib/commands/make/middleware.js

envuso make:model NAME

Create a model

USAGE
  $ envuso make:model NAME

ARGUMENTS
  NAME  Set a name for your model(Does not need to contain "Model" this will be automatically added.)

OPTIONS
  -f, --force  Force create the model, even if it exists.
  -h, --help   show CLI help

EXAMPLE
  $ envuso make:model User

See code: lib/commands/make/model.js

envuso make:policy NAME

Create a model policy

USAGE
  $ envuso make:policy NAME

ARGUMENTS
  NAME  Set a name for your model policy(Does not need to contain "Policy" this will be automatically added.)

OPTIONS
  -f, --force        Force create the model, even if it exists.
  -h, --help         show CLI help
  -m, --model=model  Define the model that this policy is for, the @policy decorator will be automatically added.

EXAMPLE
  $ envuso make:policy User

See code: lib/commands/make/policy.js

envuso make:resource NAME

Create an api resource

USAGE
  $ envuso make:resource NAME

ARGUMENTS
  NAME  Set a name for your api resource(Does not need to contain "Resource" this will be automatically added.)

OPTIONS
  -h, --help         show CLI help
  -m, --model=model  (required) Create an api resource using your model

EXAMPLE
  $ envuso make:resource User --model=User

See code: lib/commands/make/resource.js

envuso make:socket-channel-listener NAME

Create a socket channel

USAGE
  $ envuso make:socket-channel-listener NAME

ARGUMENTS
  NAME  Set a name for your socket channel

OPTIONS
  -f, --force  Force create, even if it exists.
  -h, --help   show CLI help

EXAMPLE
  $ envuso make:socket-channel-listener UserSocketChannel

See code: lib/commands/make/socket-channel-listener.js

envuso new

Create a new project

USAGE
  $ envuso new

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ envuso new

See code: lib/commands/new.js