antora-tools

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g antora-tools
$ antora-tools COMMAND
running command...
$ antora-tools (--version)
antora-tools/0.1.1 darwin-arm64 node-v18.17.0
$ antora-tools --help [COMMAND]
USAGE
  $ antora-tools COMMAND
...

Commands

• antora-tools
• antora-tools help [COMMANDS]
• antora-tools plugins
• antora-tools plugins:install PLUGIN...
• antora-tools plugins:inspect PLUGIN...
• antora-tools plugins:install PLUGIN...
• antora-tools plugins:link PLUGIN
• antora-tools plugins:uninstall PLUGIN...
• antora-tools plugins:uninstall PLUGIN...
• antora-tools plugins:uninstall PLUGIN...
• antora-tools plugins update
• antora-tools preview

antora-tools

antora

USAGE
  $ antora-tools

DESCRIPTION
  antora

EXAMPLES
  antora example

See code: dist/commands/index.ts

antora-tools help [COMMANDS]

Display help for antora-tools.

USAGE
  $ antora-tools help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

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

DESCRIPTION
  Display help for antora-tools.

See code: @oclif/plugin-help

antora-tools plugins

List installed plugins.

USAGE
  $ antora-tools plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ antora-tools plugins

See code: @oclif/plugin-plugins

antora-tools plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ antora-tools plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

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

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
  $ antora-tools plugins add

EXAMPLES
  $ antora-tools plugins:install myplugin 

  $ antora-tools plugins:install https://github.com/someuser/someplugin

  $ antora-tools plugins:install someuser/someplugin

antora-tools plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ antora-tools 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
  $ antora-tools plugins:inspect myplugin

See code: @oclif/plugin-plugins

antora-tools plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ antora-tools plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

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

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
  $ antora-tools plugins add

EXAMPLES
  $ antora-tools plugins:install myplugin 

  $ antora-tools plugins:install https://github.com/someuser/someplugin

  $ antora-tools plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

antora-tools plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ antora-tools plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

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

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
  $ antora-tools plugins:link myplugin

See code: @oclif/plugin-plugins

antora-tools plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ antora-tools plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ antora-tools plugins unlink
  $ antora-tools plugins remove

antora-tools plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ antora-tools plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ antora-tools plugins unlink
  $ antora-tools plugins remove

See code: @oclif/plugin-plugins

antora-tools plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ antora-tools plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ antora-tools plugins unlink
  $ antora-tools plugins remove

antora-tools plugins update

Update installed plugins.

USAGE
  $ antora-tools plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

antora-tools preview

Preview antora site

USAGE
  $ antora-tools preview

DESCRIPTION
  Preview antora site

EXAMPLES
  $ antora-tools preview

See code: dist/commands/preview/index.ts