leadent-config-manager-beta
v0.0.25
Published
Leadent Config Manager CLI
Downloads
5
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g leadent-config-manager-beta
$ leadent-config-manager COMMAND
running command...
$ leadent-config-manager (--version)
leadent-config-manager-beta/0.0.24 darwin-x64 node-v14.21.3
$ leadent-config-manager --help [COMMAND]
USAGE
$ leadent-config-manager COMMAND
...
Commands
leadent-config-manager hello PERSON
leadent-config-manager hello:world
leadent-config-manager help [COMMANDS]
leadent-config-manager plugins
leadent-config-manager plugins:install PLUGIN...
leadent-config-manager plugins:inspect PLUGIN...
leadent-config-manager plugins:install PLUGIN...
leadent-config-manager plugins:link PLUGIN
leadent-config-manager plugins:uninstall PLUGIN...
leadent-config-manager plugins:uninstall PLUGIN...
leadent-config-manager plugins:uninstall PLUGIN...
leadent-config-manager plugins:update
leadent-config-manager setup-frontend
leadent-config-manager setup-portal
leadent-config-manager hello PERSON
Say hello
USAGE
$ leadent-config-manager hello [PERSON] -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Who is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ oex hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
See code: dist/commands/hello/index.ts
leadent-config-manager hello:world
Say hello world
USAGE
$ leadent-config-manager hello:world
DESCRIPTION
Say hello world
EXAMPLES
$ leadent-config-manager hello:world
hello world! (./src/commands/hello/world.ts)
See code: dist/commands/hello/world.ts
leadent-config-manager help [COMMANDS]
Display help for leadent-config-manager.
USAGE
$ leadent-config-manager help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for leadent-config-manager.
See code: @oclif/plugin-help
leadent-config-manager plugins
List installed plugins.
USAGE
$ leadent-config-manager plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ leadent-config-manager plugins
See code: @oclif/plugin-plugins
leadent-config-manager plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ leadent-config-manager plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
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
$ leadent-config-manager plugins:add
EXAMPLES
$ leadent-config-manager plugins:install myplugin
$ leadent-config-manager plugins:install https://github.com/someuser/someplugin
$ leadent-config-manager plugins:install someuser/someplugin
leadent-config-manager plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ leadent-config-manager 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
$ leadent-config-manager plugins:inspect myplugin
See code: @oclif/plugin-plugins
leadent-config-manager plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ leadent-config-manager plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
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
$ leadent-config-manager plugins:add
EXAMPLES
$ leadent-config-manager plugins:install myplugin
$ leadent-config-manager plugins:install https://github.com/someuser/someplugin
$ leadent-config-manager plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
leadent-config-manager plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ leadent-config-manager plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
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
$ leadent-config-manager plugins:link myplugin
See code: @oclif/plugin-plugins
leadent-config-manager plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ leadent-config-manager plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ leadent-config-manager plugins:unlink
$ leadent-config-manager plugins:remove
leadent-config-manager plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ leadent-config-manager plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ leadent-config-manager plugins:unlink
$ leadent-config-manager plugins:remove
See code: @oclif/plugin-plugins
leadent-config-manager plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ leadent-config-manager plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ leadent-config-manager plugins:unlink
$ leadent-config-manager plugins:remove
leadent-config-manager plugins:update
Update installed plugins.
USAGE
$ leadent-config-manager plugins:update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
leadent-config-manager setup-frontend
Fetch configuration base files and merge with client specific files stored in the config repo.
USAGE
$ leadent-config-manager setup-frontend -c <value> -e <value> [-i <value>]
FLAGS
-c, --client=<value> (required) Client name (folder name in the config repo)
-e, --environment=<value> (required) Targeted environment (e.g.: dev, local, staging, production)
-i, --inherit=<value> An environment to be merged with the base file before merging with the targeted environment
DESCRIPTION
Fetch configuration base files and merge with client specific files stored in the config repo.
It has a default config and override with the client specific config.
We also have per environment configuration.
E.g.: Configuration Repo:
- base/frontend/src/config/config.js
- base/frontend/src/lang/en.json
- client1/production/frontend/src/config/config.js
- client1/production/frontend/src/lang/en.json
If you run:
$ leadent-config-manager-beta setup-frontend -c client1 -e production
It will merge the base one with the production one for the specified client and output the following files:
- src/config/config.js
- src/lang/en.json
Obs. The output files are relative to the root of the remote config repository you are pointing to.
That means that what defines the output files is the structure of the config folder, not the script itself.
If you, for example, remove the 'src/' folder from the config repo, the output files will not contain it as well.
EXAMPLES
$ leadent-config-manager-beta setup-frontend -c client1 -e production
$ leadent-config-manager-beta setup-frontend -c client1 -e local -i staging
See code: dist/commands/setup-frontend.ts
leadent-config-manager setup-portal
Fetch configuration base files and merge with client specific files stored in the config repo.
USAGE
$ leadent-config-manager setup-portal -c <value> -e <value> [-i <value>]
FLAGS
-c, --client=<value> (required) Client name (folder name in the config repo)
-e, --environment=<value> (required) Targeted environment (e.g.: dev, local, staging, production)
-i, --inherit=<value> An environment to be merged with the base file before merging with the targeted environment
DESCRIPTION
Fetch configuration base files and merge with client specific files stored in the config repo.
It has a default config and override with the client specific config.
We also have per environment configuration.
E.g.: Configuration Repo:
- base/portal/src/config/config.js
- base/portal/src/lang/en.json
- base/portal/src/sass/leadent.scss
- client1/production/portal/src/config/config.js
- client1/production/portal/src/lang/en.json
- client1/production/portal/src/sass/leadent.scss
If you run:
$ leadent-config-manager-beta setup-portal -c client1 -e production
It will merge the base one with the production one for the specified client and output the following files:
- src/config/config.js
- src/lang/en.json
- src/sass/leadent.scss
Obs. The output files are relative to the root of the remote config repository you are pointing to.
That means that what defines the output files is the structure of the config folder, not the script itself.
If you, for example, remove the 'src/' folder from the config repo, the output files will not contain it as well.
EXAMPLES
$ leadent-config-manager-beta setup-portal -c client1 -e production
$ leadent-config-manager-beta setup-portal -c client1 -e local -i staging
See code: dist/commands/setup-portal.ts