patch-yml
v0.5.0
Published
patch yml with fast-json-diff files
Downloads
11
Readme
patch-yml
使用 patch.json 更新 yml 文件 部署时,自动从项目代码更新到配置文件
Usage
$ npm install -g patch-yml
$ patch-yml COMMAND
running command...
$ patch-yml (--version)
patch-yml/0.5.0 darwin-arm64 node-v18.19.1
$ patch-yml --help [COMMAND]
USAGE
$ patch-yml COMMAND
...
Commands
patch-yml diff ORIGINYML TARGETYML
patch-yml help [COMMAND]
patch-yml patch ORIGINYML PATCHJSON
patch-yml plugins
patch-yml plugins:install PLUGIN...
patch-yml plugins:inspect PLUGIN...
patch-yml plugins:install PLUGIN...
patch-yml plugins:link PLUGIN
patch-yml plugins:uninstall PLUGIN...
patch-yml plugins reset
patch-yml plugins:uninstall PLUGIN...
patch-yml plugins:uninstall PLUGIN...
patch-yml plugins update
patch-yml diff ORIGINYML TARGETYML
根据 origin.yml target.yml 生成 patch.json
USAGE
$ patch-yml diff ORIGINYML TARGETYML
ARGUMENTS
ORIGINYML eg. base.yml
TARGETYML eg. target.yml
DESCRIPTION
根据 origin.yml target.yml 生成 patch.json
EXAMPLES
$ patch-yml diff origin.yml target.yml > patch.json
See code: src/commands/diff.ts
patch-yml help [COMMAND]
Display help for patch-yml.
USAGE
$ patch-yml 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 patch-yml.
See code: @oclif/plugin-help
patch-yml patch ORIGINYML PATCHJSON
将 patch.json 应用到 base.yml; 保持原有的 yaml 格式
USAGE
$ patch-yml patch ORIGINYML PATCHJSON
ARGUMENTS
ORIGINYML eg. base.yml
PATCHJSON eg. patch.json
DESCRIPTION
将 patch.json 应用到 base.yml; 保持原有的 yaml 格式
EXAMPLES
$ patch-yml patch base.yml patch.json > target.yml
See code: src/commands/patch.ts
patch-yml plugins
List installed plugins.
USAGE
$ patch-yml plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ patch-yml plugins
See code: @oclif/plugin-plugins
patch-yml plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ patch-yml plugins add plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-s, --silent Silences yarn output.
-v, --verbose Show verbose yarn output.
GLOBAL FLAGS
--json Format output as json.
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
$ patch-yml plugins add
EXAMPLES
$ patch-yml plugins add myplugin
$ patch-yml plugins add https://github.com/someuser/someplugin
$ patch-yml plugins add someuser/someplugin
patch-yml plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ patch-yml 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
$ patch-yml plugins inspect myplugin
See code: @oclif/plugin-plugins
patch-yml plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ patch-yml plugins install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-s, --silent Silences yarn output.
-v, --verbose Show verbose yarn output.
GLOBAL FLAGS
--json Format output as json.
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
$ patch-yml plugins add
EXAMPLES
$ patch-yml plugins install myplugin
$ patch-yml plugins install https://github.com/someuser/someplugin
$ patch-yml plugins install someuser/someplugin
See code: @oclif/plugin-plugins
patch-yml plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ patch-yml plugins link PLUGIN
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
$ patch-yml plugins link myplugin
See code: @oclif/plugin-plugins
patch-yml plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ patch-yml plugins remove plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ patch-yml plugins unlink
$ patch-yml plugins remove
EXAMPLES
$ patch-yml plugins remove myplugin
patch-yml plugins reset
Remove all user-installed and linked plugins.
USAGE
$ patch-yml 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
patch-yml plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ patch-yml plugins uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ patch-yml plugins unlink
$ patch-yml plugins remove
EXAMPLES
$ patch-yml plugins uninstall myplugin
See code: @oclif/plugin-plugins
patch-yml plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ patch-yml plugins unlink plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ patch-yml plugins unlink
$ patch-yml plugins remove
EXAMPLES
$ patch-yml plugins unlink myplugin
patch-yml plugins update
Update installed plugins.
USAGE
$ patch-yml plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins