marmos-docfx v0.3.0

typescript

A new CLI generated with oclif

• Usage
• Commands

Usage

$ npm install -g marmos-docfx
$ marmos-docfx COMMAND
running command...
$ marmos-docfx (--version)
marmos-docfx/0.3.0 linux-x64 node-v20.16.0
$ marmos-docfx --help [COMMAND]
USAGE
  $ marmos-docfx COMMAND
...

Commands

• marmos-docfx convert [INPUTFILES]
• marmos-docfx help [COMMAND]
• marmos-docfx plugins
• marmos-docfx plugins add PLUGIN
• marmos-docfx plugins:inspect PLUGIN...
• marmos-docfx plugins install PLUGIN
• marmos-docfx plugins link PATH
• marmos-docfx plugins remove [PLUGIN]
• marmos-docfx plugins reset
• marmos-docfx plugins uninstall [PLUGIN]
• marmos-docfx plugins unlink [PLUGIN]
• marmos-docfx plugins update

marmos-docfx convert [INPUTFILES]

describe the command here

USAGE
  $ marmos-docfx convert [INPUTFILES...] --outputFolder <value>

ARGUMENTS
  INPUTFILES...  .json files containing a marmos model to convert

FLAGS
  --outputFolder=<value>  (required) output folder for the docfx model

DESCRIPTION
  describe the command here

EXAMPLES
  $ marmos-docfx convert

See code: src/commands/convert.ts

marmos-docfx help [COMMAND]

Display help for marmos-docfx.

USAGE
  $ marmos-docfx 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 marmos-docfx.

See code: @oclif/plugin-help

marmos-docfx plugins

List installed plugins.

USAGE
  $ marmos-docfx plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ marmos-docfx plugins

See code: @oclif/plugin-plugins

marmos-docfx plugins add PLUGIN

Installs a plugin into marmos-docfx.

USAGE
  $ marmos-docfx 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 marmos-docfx.

  Uses npm to install plugins.

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

  Use the MARMOS_DOCFX_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the MARMOS_DOCFX_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ marmos-docfx plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ marmos-docfx plugins add myplugin

  Install a plugin from a github url.

    $ marmos-docfx plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ marmos-docfx plugins add someuser/someplugin

marmos-docfx plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

marmos-docfx plugins install PLUGIN

Installs a plugin into marmos-docfx.

USAGE
  $ marmos-docfx 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 marmos-docfx.

  Uses npm to install plugins.

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

  Use the MARMOS_DOCFX_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the MARMOS_DOCFX_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ marmos-docfx plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ marmos-docfx plugins install myplugin

  Install a plugin from a github url.

    $ marmos-docfx plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ marmos-docfx plugins install someuser/someplugin

See code: @oclif/plugin-plugins

marmos-docfx plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ marmos-docfx 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
  $ marmos-docfx plugins link myplugin

See code: @oclif/plugin-plugins

marmos-docfx plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ marmos-docfx 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
  $ marmos-docfx plugins unlink
  $ marmos-docfx plugins remove

EXAMPLES
  $ marmos-docfx plugins remove myplugin

marmos-docfx plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ marmos-docfx 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

marmos-docfx plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ marmos-docfx 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
  $ marmos-docfx plugins unlink
  $ marmos-docfx plugins remove

EXAMPLES
  $ marmos-docfx plugins uninstall myplugin

See code: @oclif/plugin-plugins

marmos-docfx plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ marmos-docfx 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
  $ marmos-docfx plugins unlink
  $ marmos-docfx plugins remove

EXAMPLES
  $ marmos-docfx plugins unlink myplugin

marmos-docfx plugins update

Update installed plugins.

USAGE
  $ marmos-docfx plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins