From 85ddb3fbadee0bbac78a49feb1748e9f0e894c4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BAlio=20Guedes?= Date: Fri, 13 Sep 2024 17:14:15 -0300 Subject: [PATCH 1/2] Updates documentation regarding installation and usage of this plugin --- README.md | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 67a6a6f..10e88aa 100644 --- a/README.md +++ b/README.md @@ -25,30 +25,33 @@ For more information, read [Ocliff Docs](https://oclif.io/docs/introduction). # Usage ```sh-session -$ npm install -g @vtex/cli-plugin-infra -$ vtex COMMAND -running command... -$ vtex (-v|--version|version) -@vtex/cli-plugin-infra/1.0.0 linux-x64 node-v12.22.1 -$ vtex --help [COMMAND] +$ vtex plugins install infra +$ vtex infra --help +Installs, updates, or lists infra services. Run 'vtex infra' to see all 3 subcommands + USAGE - $ vtex COMMAND + $ vtex infra COMMAND + +COMMANDS + infra install Installs an infra service. + infra list Lists installed infra services. + infra update Updates all installed infra services. ... ``` # Commands -* [`vtex infra:install SERVICEID`](#vtex-infrainstall-serviceid) -* [`vtex infra:list [NAME]`](#vtex-infralist-name) -* [`vtex infra:update`](#vtex-infraupdate) +* [`vtex infra install SERVICEID`](#vtex-infrainstall-serviceid) +* [`vtex infra list [NAME]`](#vtex-infralist-name) +* [`vtex infra update`](#vtex-infraupdate) -## `vtex infra:install SERVICEID` +## `vtex infra install SERVICEID` Installs an infra service. ``` USAGE - $ vtex infra:install SERVICEID + $ vtex infra install SERVICEID ARGUMENTS SERVICEID Name and version of the service ({vendor}.{servicename}@{x.x.x}) to install. @@ -71,7 +74,7 @@ Lists installed infra services. ``` USAGE - $ vtex infra:list [NAME] + $ vtex infra list [NAME] ARGUMENTS NAME Service name. @@ -84,7 +87,7 @@ OPTIONS --trace Ensure all requests to VTEX IO are traced ALIASES - $ vtex infra:ls + $ vtex infra ls EXAMPLES vtex infra list @@ -99,7 +102,7 @@ Updates all installed infra services. ``` USAGE - $ vtex infra:update + $ vtex infra update OPTIONS -h, --help show CLI help From f51ad4d327306a9ca69fbc2ce2fa9544c388572a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BAlio=20Guedes?= Date: Fri, 13 Sep 2024 20:15:04 +0000 Subject: [PATCH 2/2] Automatic update on Toolbelt plugin documentation --- README.md | 33 +++++++++++++++------------------ 1 file changed, 15 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 10e88aa..9687520 100644 --- a/README.md +++ b/README.md @@ -25,33 +25,30 @@ For more information, read [Ocliff Docs](https://oclif.io/docs/introduction). # Usage ```sh-session -$ vtex plugins install infra -$ vtex infra --help -Installs, updates, or lists infra services. Run 'vtex infra' to see all 3 subcommands - +$ npm install -g @vtex/cli-plugin-infra +$ vtex COMMAND +running command... +$ vtex (-v|--version|version) +@vtex/cli-plugin-infra/1.0.0 linux-x64 node-v12.22.12 +$ vtex --help [COMMAND] USAGE - $ vtex infra COMMAND - -COMMANDS - infra install Installs an infra service. - infra list Lists installed infra services. - infra update Updates all installed infra services. + $ vtex COMMAND ... ``` # Commands -* [`vtex infra install SERVICEID`](#vtex-infrainstall-serviceid) -* [`vtex infra list [NAME]`](#vtex-infralist-name) -* [`vtex infra update`](#vtex-infraupdate) +* [`vtex infra:install SERVICEID`](#vtex-infrainstall-serviceid) +* [`vtex infra:list [NAME]`](#vtex-infralist-name) +* [`vtex infra:update`](#vtex-infraupdate) -## `vtex infra install SERVICEID` +## `vtex infra:install SERVICEID` Installs an infra service. ``` USAGE - $ vtex infra install SERVICEID + $ vtex infra:install SERVICEID ARGUMENTS SERVICEID Name and version of the service ({vendor}.{servicename}@{x.x.x}) to install. @@ -74,7 +71,7 @@ Lists installed infra services. ``` USAGE - $ vtex infra list [NAME] + $ vtex infra:list [NAME] ARGUMENTS NAME Service name. @@ -87,7 +84,7 @@ OPTIONS --trace Ensure all requests to VTEX IO are traced ALIASES - $ vtex infra ls + $ vtex infra:ls EXAMPLES vtex infra list @@ -102,7 +99,7 @@ Updates all installed infra services. ``` USAGE - $ vtex infra update + $ vtex infra:update OPTIONS -h, --help show CLI help