oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g ilbal
$ ilbal COMMAND
running command...
$ ilbal (--version)
ilbal/0.4.0 linux-x64 node-v20.17.0
$ ilbal --help [COMMAND]
USAGE
  $ ilbal COMMAND
...

Commands

• ilbal data list
• ilbal data load DATASET
• ilbal help [COMMAND]
• ilbal init [DIRECTORY]
• ilbal plugins
• ilbal plugins add PLUGIN
• ilbal plugins:inspect PLUGIN...
• ilbal plugins install PLUGIN
• ilbal plugins link PATH
• ilbal plugins remove [PLUGIN]
• ilbal plugins reset
• ilbal plugins uninstall [PLUGIN]
• ilbal plugins unlink [PLUGIN]
• ilbal plugins update
• ilbal reset
• ilbal start
• ilbal status all
• ilbal status configuration
• ilbal status containers
• ilbal stop

ilbal data list

List available datasets

USAGE
  $ ilbal data list

DESCRIPTION
  List available datasets

EXAMPLES
  $ ilbal data list

See code: src/commands/data/list.ts

ilbal data load DATASET

Load available dataset

USAGE
  $ ilbal data load DATASET

ARGUMENTS
  DATASET  Dataset to load

DESCRIPTION
  Load available dataset

EXAMPLES
  $ ilbal data load

See code: src/commands/data/load.ts

ilbal help [COMMAND]

Display help for ilbal.

USAGE
  $ ilbal help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for ilbal.

See code: @oclif/plugin-help

ilbal init [DIRECTORY]

Initialize ilbal app

USAGE
  $ ilbal init [DIRECTORY]

ARGUMENTS
  DIRECTORY  Directory in which to create app

DESCRIPTION
  Initialize ilbal app

  Initialize an instance of the ilbal app.

EXAMPLES
  $ ilbal init

See code: src/commands/init.ts

ilbal plugins

List installed plugins.

USAGE
  $ ilbal plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ ilbal plugins

See code: @oclif/plugin-plugins

ilbal plugins add PLUGIN

Installs a plugin into ilbal.

USAGE
  $ ilbal plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into ilbal.

  Uses npm to install plugins.

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

  Use the ILBAL_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the ILBAL_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ ilbal plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ ilbal plugins add myplugin

  Install a plugin from a github url.

    $ ilbal plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ ilbal plugins add someuser/someplugin

ilbal plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ ilbal plugins inspect PLUGIN...

ARGUMENTS
  PLUGIN...  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ ilbal plugins inspect myplugin

See code: @oclif/plugin-plugins

ilbal plugins install PLUGIN

Installs a plugin into ilbal.

USAGE
  $ ilbal plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into ilbal.

  Uses npm to install plugins.

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

  Use the ILBAL_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the ILBAL_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ ilbal plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ ilbal plugins install myplugin

  Install a plugin from a github url.

    $ ilbal plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ ilbal plugins install someuser/someplugin

See code: @oclif/plugin-plugins

ilbal plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ ilbal plugins link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION
  Links a plugin into the CLI for development.
  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.


EXAMPLES
  $ ilbal plugins link myplugin

See code: @oclif/plugin-plugins

ilbal plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ ilbal plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ilbal plugins unlink
  $ ilbal plugins remove

EXAMPLES
  $ ilbal plugins remove myplugin

ilbal plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ ilbal plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

ilbal plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ ilbal plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ilbal plugins unlink
  $ ilbal plugins remove

EXAMPLES
  $ ilbal plugins uninstall myplugin

See code: @oclif/plugin-plugins

ilbal plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ ilbal plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ilbal plugins unlink
  $ ilbal plugins remove

EXAMPLES
  $ ilbal plugins unlink myplugin

ilbal plugins update

Update installed plugins.

USAGE
  $ ilbal plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

ilbal reset

Resets docker network, volumes and containers

USAGE
  $ ilbal reset

DESCRIPTION
  Resets docker network, volumes and containers

EXAMPLES
  $ ilbal reset

See code: src/commands/reset.ts

ilbal start

Starts ilbal docker containers

USAGE
  $ ilbal start

DESCRIPTION
  Starts ilbal docker containers

EXAMPLES
  $ ilbal start

See code: src/commands/start.ts

ilbal status all

Print configuration and list containers

USAGE
  $ ilbal status all [-a]

FLAGS
  -a, --all  Print running and stopped containers information

DESCRIPTION
  Print configuration and list containers

EXAMPLES
  $ ilbal status all

See code: src/commands/status/all.ts

ilbal status configuration

Print project configuration

USAGE
  $ ilbal status configuration

DESCRIPTION
  Print project configuration

EXAMPLES
  $ ilbal status configuration

See code: src/commands/status/configuration.ts

ilbal status containers

List project containers

USAGE
  $ ilbal status containers [-a]

FLAGS
  -a, --all  Print running and stopped containers information

DESCRIPTION
  List project containers

EXAMPLES
  $ ilbal status containers

See code: src/commands/status/containers.ts

ilbal stop

Stops ilbal docker containers

USAGE
  $ ilbal stop

DESCRIPTION
  Stops ilbal docker containers

EXAMPLES
  $ ilbal stop

See code: src/commands/stop.ts