@dleangen/cage-git
v0.0.1
Published
Git workflow mechanics for CAGE projects.
Readme
@dleangen/cage-git
Git workflow mechanics for CAGE projects.
cage-git help [COMMAND]cage-git landcage-git pluginscage-git plugins add PLUGINcage-git plugins:inspect PLUGIN...cage-git plugins install PLUGINcage-git plugins link PATHcage-git plugins remove [PLUGIN]cage-git plugins resetcage-git plugins uninstall [PLUGIN]cage-git plugins unlink [PLUGIN]cage-git plugins update
cage-git help [COMMAND]
Display help for cage-git.
USAGE
$ cage-git 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 cage-git.See code: @oclif/plugin-help
cage-git land
Safe, inspect-before-merge branch landing
USAGE
$ cage-git land --from <value> --into <value> [--accept | --analyze | --preview | --reject | --cleanup]
[--force]
FLAGS
--accept Merge landing branch into target
--analyze Preflight analysis (read-only)
--cleanup Delete backup branch if present
--force Bypass pushed-branch guard (--preview only)
--from=<value> (required) Branch to land
--into=<value> (required) Target branch to land into
--preview Create landing branch with cherry-picked commits
--reject Discard landing branch; leave original untouched
DESCRIPTION
Safe, inspect-before-merge branch landing
EXAMPLES
$ cage-git land --from feat/foo --into main --analyze
$ cage-git land --from feat/foo --into main --preview
$ cage-git land --from feat/foo --into main --acceptSee code: src/commands/land.ts
cage-git plugins
List installed plugins.
USAGE
$ cage-git plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ cage-git pluginsSee code: @oclif/plugin-plugins
cage-git plugins add PLUGIN
Installs a plugin into cage-git.
USAGE
$ cage-git 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 cage-git.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the CAGE_GIT_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the CAGE_GIT_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ cage-git plugins add
EXAMPLES
Install a plugin from npm registry.
$ cage-git plugins add myplugin
Install a plugin from a github url.
$ cage-git plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ cage-git plugins add someuser/someplugincage-git plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ cage-git 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
$ cage-git plugins inspect mypluginSee code: @oclif/plugin-plugins
cage-git plugins install PLUGIN
Installs a plugin into cage-git.
USAGE
$ cage-git 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 cage-git.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the CAGE_GIT_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the CAGE_GIT_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ cage-git plugins add
EXAMPLES
Install a plugin from npm registry.
$ cage-git plugins install myplugin
Install a plugin from a github url.
$ cage-git plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ cage-git plugins install someuser/somepluginSee code: @oclif/plugin-plugins
cage-git plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ cage-git 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
$ cage-git plugins link mypluginSee code: @oclif/plugin-plugins
cage-git plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ cage-git 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
$ cage-git plugins unlink
$ cage-git plugins remove
EXAMPLES
$ cage-git plugins remove myplugincage-git plugins reset
Remove all user-installed and linked plugins.
USAGE
$ cage-git 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
cage-git plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ cage-git 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
$ cage-git plugins unlink
$ cage-git plugins remove
EXAMPLES
$ cage-git plugins uninstall mypluginSee code: @oclif/plugin-plugins
cage-git plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ cage-git 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
$ cage-git plugins unlink
$ cage-git plugins remove
EXAMPLES
$ cage-git plugins unlink myplugincage-git plugins update
Update installed plugins.
USAGE
$ cage-git plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
