@hoevelmanns/vcli

vcli

An universal and extensible CLI

Wraps your current Command Line Interfaces and allows you to stream the CLI commands in custom commands.

• Usage
• Commands

Usage

$ npm install -g @hoevelmanns/vcli
$ vc COMMAND
running command...
$ vc (-v|--version|version)
@hoevelmanns/vcli/1.3.30 linux-x64 node-v12.13.1
$ vc --help [COMMAND]
USAGE
  $ vc COMMAND
...

Commands

• vc autocomplete [SHELL]
• vc conf [KEY] [VALUE]
• vc create
• vc help [COMMAND]
• vc refresh [VM]
• vc search
• vc vm (v) [COMMAND]
• vc workspace

vc autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ vc autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

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

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

See code: @oclif/plugin-autocomplete

vc conf [KEY] [VALUE]

manage configuration

USAGE
  $ vc conf [KEY] [VALUE]

ARGUMENTS
  KEY    key of the config
  VALUE  value of the config

OPTIONS
  -d, --cwd=cwd          config file location
  -d, --delete           delete?
  -h, --help             show CLI help
  -k, --key=key          key of the config
  -n, --name=name        config file name
  -p, --project=project  project name
  -v, --value=value      value of the config

See code: conf-cli

vc create

create workspace

USAGE
  $ vc create

OPTIONS
  -h, --help    show CLI help
  -n, --create  create workspace

See code: src/commands/create.ts

vc help [COMMAND]

display help for vc

USAGE
  $ vc help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

vc refresh [VM]

add commands from external consoles defined in .vclirc.json to VCLI

USAGE
  $ vc refresh [VM]

OPTIONS
  -h, --help       show CLI help
  -o, --overwrite  delete existing commands
  -v, --vm         (alias: vm) run generator in virtual machine

ALIASES
  $ vc r

See code: src/commands/refresh.ts

vc search

search for commands, apps, etc.

USAGE
  $ vc search

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ vc s

See code: src/commands/search.ts

vc vm (v) [COMMAND]

virtual machine

USAGE
  $ vc vm (v) [COMMAND]

OPTIONS
  -h, --help  show CLI help
  -s, --halt  stop the VM
  -u, --up    start the VM

ALIASES
  $ vc v

See code: src/commands/vm.ts

vc workspace

manage workspace

USAGE
  $ vc workspace

OPTIONS
  -h, --help         show CLI help
  -i, --hideCommand  hide commands

ALIASES
  $ vc ws

See code: src/commands/workspace.ts