nuradocs v0.0.1

nuradocs

Automated understandable docs.

• Usage
• Commands

Usage

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

Commands

• nuradocs explain [SOURCE] [DESTINATION]
• nuradocs help [COMMAND]
• nuradocs plugins
• nuradocs plugins add PLUGIN
• nuradocs plugins:inspect PLUGIN...
• nuradocs plugins install PLUGIN
• nuradocs plugins link PATH
• nuradocs plugins remove [PLUGIN]
• nuradocs plugins reset
• nuradocs plugins uninstall [PLUGIN]
• nuradocs plugins unlink [PLUGIN]
• nuradocs plugins update

nuradocs explain [SOURCE] [DESTINATION]

Generate understandable documentation

USAGE
  $ nuradocs explain [SOURCE] [DESTINATION]

ARGUMENTS
  SOURCE       source code to read. [folder | file ]
  DESTINATION  destination to generate the documentation [ folder ]. Default is ./docs

DESCRIPTION
  Generate understandable documentation

EXAMPLES
  $ nuradocs explain

  $ nuradocs explain /path/to/your/source/file.js /path/to/your/dest/

  $ nuradocs explain /path/to/your/source/folder/ /path/to/your/dest/

See code: src/commands/explain/index.ts

nuradocs help [COMMAND]

Display help for nuradocs.

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

See code: @oclif/plugin-help

nuradocs plugins

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ nuradocs plugins

See code: @oclif/plugin-plugins

nuradocs plugins add PLUGIN

Installs a plugin into nuradocs.

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

  Uses npm to install plugins.

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

  Use the NURADOCS_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the NURADOCS_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ nuradocs plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ nuradocs plugins add myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ nuradocs plugins add someuser/someplugin

nuradocs plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

nuradocs plugins install PLUGIN

Installs a plugin into nuradocs.

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

  Uses npm to install plugins.

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

  Use the NURADOCS_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the NURADOCS_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ nuradocs plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ nuradocs plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ nuradocs plugins install someuser/someplugin

See code: @oclif/plugin-plugins

nuradocs plugins link PATH

Links a plugin into the CLI for development.

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

See code: @oclif/plugin-plugins

nuradocs plugins remove [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ nuradocs plugins remove myplugin

nuradocs plugins reset

Remove all user-installed and linked plugins.

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

nuradocs plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ nuradocs plugins uninstall myplugin

See code: @oclif/plugin-plugins

nuradocs plugins unlink [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ nuradocs plugins unlink myplugin

nuradocs plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins