xtm-cli
v0.0.0
Published
A new CLI generated with oclif
Readme
cli-demo
A new CLI generated with oclif
Usage
$ npm install -g xtm-cli
$ XTM COMMAND
running command...
$ XTM (--version)
xtm-cli/0.0.0 linux-x64 node-v18.20.2
$ XTM --help [COMMAND]
USAGE
$ XTM COMMAND
...Commands
XTM help [COMMAND]XTM pluginsXTM plugins add PLUGINXTM plugins:inspect PLUGIN...XTM plugins install PLUGINXTM plugins link PATHXTM plugins remove [PLUGIN]XTM plugins resetXTM plugins uninstall [PLUGIN]XTM plugins unlink [PLUGIN]XTM plugins update
XTM help [COMMAND]
Display help for XTM.
USAGE
$ XTM 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 XTM.See code: @oclif/plugin-help
XTM plugins
List installed plugins.
USAGE
$ XTM plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ XTM pluginsSee code: @oclif/plugin-plugins
XTM plugins add PLUGIN
Installs a plugin into XTM.
USAGE
$ XTM 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 XTM.
Uses bundled npm executable to install plugins into /home/runner/.local/share/XTM
Installation of a user-installed plugin will override a core plugin.
Use the XTM_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the XTM_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ XTM plugins add
EXAMPLES
Install a plugin from npm registry.
$ XTM plugins add myplugin
Install a plugin from a github url.
$ XTM plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ XTM plugins add someuser/somepluginXTM plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ XTM 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
$ XTM plugins inspect mypluginSee code: @oclif/plugin-plugins
XTM plugins install PLUGIN
Installs a plugin into XTM.
USAGE
$ XTM 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 XTM.
Uses bundled npm executable to install plugins into /home/runner/.local/share/XTM
Installation of a user-installed plugin will override a core plugin.
Use the XTM_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the XTM_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ XTM plugins add
EXAMPLES
Install a plugin from npm registry.
$ XTM plugins install myplugin
Install a plugin from a github url.
$ XTM plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ XTM plugins install someuser/somepluginSee code: @oclif/plugin-plugins
XTM plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ XTM 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
$ XTM plugins link mypluginSee code: @oclif/plugin-plugins
XTM plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ XTM 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
$ XTM plugins unlink
$ XTM plugins remove
EXAMPLES
$ XTM plugins remove mypluginXTM plugins reset
Remove all user-installed and linked plugins.
USAGE
$ XTM 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
XTM plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ XTM 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
$ XTM plugins unlink
$ XTM plugins remove
EXAMPLES
$ XTM plugins uninstall mypluginSee code: @oclif/plugin-plugins
XTM plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ XTM 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
$ XTM plugins unlink
$ XTM plugins remove
EXAMPLES
$ XTM plugins unlink mypluginXTM plugins update
Update installed plugins.
USAGE
$ XTM plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
