https://github.com/devitools/cli
:computer: Command line wizard to help create resources and manipulate projects
https://github.com/devitools/cli
cli devi devitools hacktoberfest hacktoberfest-accepted
Last synced: 4 months ago
JSON representation
:computer: Command line wizard to help create resources and manipulate projects
- Host: GitHub
- URL: https://github.com/devitools/cli
- Owner: devitools
- Created: 2020-07-06T06:21:48.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-01-27T03:09:50.000Z (almost 3 years ago)
- Last Synced: 2025-09-06T05:38:41.521Z (5 months ago)
- Topics: cli, devi, devitools, hacktoberfest, hacktoberfest-accepted
- Language: TypeScript
- Homepage:
- Size: 664 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
@devitools/cli
===
Command line devitools
[](https://oclif.io)
[](https://npmjs.org/package/cli)
[](https://npmjs.org/package/cli)
[](https://github.com/devitools/cli/blob/master/package.json)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ 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-add-domain)
* [`devi autocomplete [SHELL]`](#devi-autocomplete-shell)
* [`devi create FOLDER [REPO]`](#devi-create-folder-repo)
* [`devi env`](#devi-env)
* [`devi help [COMMAND]`](#devi-help-command)
* [`devi init`](#devi-init)
* [`devi pull`](#devi-pull)
* [`devi update [CHANNEL]`](#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](https://github.com/devitools/cli/blob/v0.11.0/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](https://github.com/oclif/plugin-autocomplete/blob/v0.2.1/src/commands/autocomplete/index.ts)_
## `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
```
_See code: [src/commands/create.ts](https://github.com/devitools/cli/blob/v0.11.0/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](https://github.com/devitools/cli/blob/v0.11.0/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](https://github.com/oclif/plugin-help/blob/v3.2.2/src/commands/help.ts)_
## `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](https://github.com/devitools/cli/blob/v0.11.0/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](https://github.com/devitools/cli/blob/v0.11.0/src/commands/pull.ts)_
## `devi update [CHANNEL]`
update the devi CLI
```
USAGE
$ devi update [CHANNEL]
```
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v1.3.10/src/commands/update.ts)_