@gowner/gjcli v0.0.0

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g @gowner/gjcli
$ gj COMMAND
running command...
$ gj (--version)
@gowner/gjcli/0.0.0 linux-x64 node-v20.12.2
$ gj --help [COMMAND]
USAGE
  $ gj COMMAND
...

Commands

• gj ai ask [PROMPT]
• gj git archive REPO
• gj help [COMMAND]
• gj plugins
• gj plugins:install PLUGIN...
• gj plugins:inspect PLUGIN...
• gj plugins:install PLUGIN...
• gj plugins:link PLUGIN
• gj plugins:uninstall PLUGIN...
• gj plugins reset
• gj plugins:uninstall PLUGIN...
• gj plugins:uninstall PLUGIN...
• gj plugins update

gj ai ask [PROMPT]

describe the command here

USAGE
  $ gj ai ask [PROMPT] [-s <value>]

ARGUMENTS
  PROMPT  What to say to the AI

FLAGS
  -s, --systemMessage=<value>  system message to display

DESCRIPTION
  describe the command here

EXAMPLES
  $ gj ai ask

See code: src/commands/ai/ask.ts

gj git archive REPO

Archive a Git repository

USAGE
  $ gj git archive REPO [-a <value>]

ARGUMENTS
  REPO  Repository to archive

FLAGS
  -a, --archiveFolder=<value>  [default: N:/git-archive] Archive folder

DESCRIPTION
  Archive a Git repository

EXAMPLES
  $ gj git archive

See code: src/commands/git/archive.ts

gj help [COMMAND]

Display help for gj.

USAGE
  $ gj 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 gj.

See code: @oclif/plugin-help

gj plugins

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ gj plugins

See code: @oclif/plugin-plugins

gj plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ gj plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -s, --silent   Silences yarn output.
  -v, --verbose  Show verbose yarn output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

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

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ gj plugins add

EXAMPLES
  $ gj plugins add myplugin 

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

  $ gj plugins add someuser/someplugin

gj plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ gj 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
  $ gj plugins inspect myplugin

See code: @oclif/plugin-plugins

gj plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ gj plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -s, --silent   Silences yarn output.
  -v, --verbose  Show verbose yarn output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

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

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ gj plugins add

EXAMPLES
  $ gj plugins install myplugin 

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

  $ gj plugins install someuser/someplugin

See code: @oclif/plugin-plugins

gj plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ gj plugins:link PLUGIN

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
  $ gj plugins link myplugin

See code: @oclif/plugin-plugins

gj plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ gj plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ gj plugins unlink
  $ gj plugins remove

EXAMPLES
  $ gj plugins remove myplugin

gj plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ gj 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

gj plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ gj plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ gj plugins unlink
  $ gj plugins remove

EXAMPLES
  $ gj plugins uninstall myplugin

See code: @oclif/plugin-plugins

gj plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ gj plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ gj plugins unlink
  $ gj plugins remove

EXAMPLES
  $ gj plugins unlink myplugin

gj plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins