@devitools/cli

Command line devitools

• Usage
• Commands

Usage

$ npm install -g @devitools/cli
$ devi COMMAND
running command...
$ devi (-v|--version|version)
@devitools/cli/0.11.0 linux-x64 node-v16.6.2
$ devi --help [COMMAND]
USAGE
  $ devi COMMAND
...

Commands

• devi add DOMAIN
• devi autocomplete [SHELL]
• devi create FOLDER [REPO]
• devi env
• devi help [COMMAND]
• devi init
• devi pull
• devi update [CHANNEL]

devi add DOMAIN

initialize a directory to be recognized as a devitools project

USAGE
  $ devi add DOMAIN

ARGUMENTS
  DOMAIN  the domain that will be created

OPTIONS
  -g, --group
  -h, --help                   show CLI help
  -o, --override
  -p, --parameters=parameters
  -t, --template=template

EXAMPLES
  $ devi add general --group | devi add general -g // create new namespace without schemas
  $ devi add main.category // add a new entity Category namespaced by Main
  $ devi add financial.bank-account // use kebab case
  $ devi add main.company.partners // use dot notation to nested items
  $ devi add foo.bar -o | devi add foo.bar --override // override all without ask
  $ devi add foo.bar -t=my-template // use a custom template (the default value is default)
  $ devi add foo.bar --template=my-template // use a custom template (the default value is default)
  $ devi add foo.bar -p=whatever | devi add foo.bar --parameters=whatever
  * special parameters:
     - devi add foo.bar -p=array
     - devi add foo.bar -p=builtin
  * JSON support:
     - devi add foo.bar -p={"foo":"bar"}

See code: src/commands/add.ts

devi autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ devi autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

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

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

See code: @oclif/plugin-autocomplete

devi create FOLDER [REPO]

create a new devitools project

USAGE
  $ devi create FOLDER [REPO]

ARGUMENTS
  FOLDER  [default: devitools] the name of the new project folder
  REPO    [default: https://github.com/devitools/starter-kit.git] repository base to create the new project

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ devi create <name>

See code: src/commands/create.ts

devi env

update the devitools resources

USAGE
  $ devi env

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ devi env

See code: src/commands/env.ts

devi help [COMMAND]

display help for devi

USAGE
  $ devi help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

devi init

initialize a directory to be recognized as a devitools project

USAGE
  $ devi init

OPTIONS
  -b, --back
  -f, --front
  -h, --help   show CLI help

EXAMPLES
  $ devi init
  $ devi init -f | devi init --front // init a project with just frontend
  $ devi init -b | devi init --back // init a project with just backend

See code: src/commands/init.ts

devi pull

update the devitools resources

USAGE
  $ devi pull

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ devi pull

See code: src/commands/pull.ts

devi update [CHANNEL]

update the devi CLI

USAGE
  $ devi update [CHANNEL]

See code: @oclif/plugin-update