npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

antora-tools

v0.1.1

Published

Antora cli tool to support development

Downloads

3

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

tanapolntanapoln

Keywords

oclif

Readme

oclif-hello-world

oclif example Hello World CLI

oclif CircleCI GitHub license

Usage

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

Commands

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