0.1.4 • Published 5 months ago
almic v0.1.4
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g almic
$ almic COMMAND
running command...
$ almic (--version)
almic/0.1.4 darwin-arm64 node-v18.18.0
$ almic --help [COMMAND]
USAGE
$ almic COMMAND
...
Commands
almic db sync
almic docker configure FIRSTARG
almic help [COMMANDS]
almic plugins
almic plugins:install PLUGIN...
almic plugins:inspect PLUGIN...
almic plugins:install PLUGIN...
almic plugins:link PLUGIN
almic plugins:uninstall PLUGIN...
almic plugins reset
almic plugins:uninstall PLUGIN...
almic plugins:uninstall PLUGIN...
almic plugins update
almic db sync
Synchronize Databases between environments
USAGE
$ almic db sync [--json] [--log-level debug|info|warn|error] [-d <value>] [-p
pp_to_local|prod_to_pp|prod_to_local]
FLAGS
-d, --database=<value> Database to sync
-p, --procedure=<option> Database Sync Procedure
<options: pp_to_local|prod_to_pp|prod_to_local>
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> Specify level for logging.
<options: debug|info|warn|error>
DESCRIPTION
Synchronize Databases between environments
- local
- pp
- prod
EXAMPLES
$ almic db sync
$ almic db sync -p pp_to_local
$ almic db sync -d almi-hr
$ almic db sync -d almi-hr -p pp_to_local
FLAG DESCRIPTIONS
-d, --database=<value> Database to sync
Select which database you would like to sync for the selected process
-p, --procedure=pp_to_local|prod_to_pp|prod_to_local Database Sync Procedure
Set the Database Sync Procedure.
almic docker configure FIRSTARG
Create .env for docker-compose
USAGE
$ almic docker configure FIRSTARG [--json] [--log-level debug|info|warn|error] [-d <value>] [-i <value>] [-o <value>]
ARGUMENTS
FIRSTARG Path to save generated .env
FLAGS
-d, --defaults=<value> Use default values
-i, --input=<value> [default: /Users/ysk/git/almic/docker-conf.yml] Input configuration file template
-o, --output=<value> Output configuration file .env
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> Specify level for logging.
<options: debug|info|warn|error>
almic help [COMMANDS]
Display help for almic.
USAGE
$ almic 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 almic.
See code: @oclif/plugin-help
almic plugins
List installed plugins.
USAGE
$ almic plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ almic plugins
See code: @oclif/plugin-plugins
almic plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ almic 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
$ almic plugins add
EXAMPLES
$ almic plugins add myplugin
$ almic plugins add https://github.com/someuser/someplugin
$ almic plugins add someuser/someplugin
almic plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ almic 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
$ almic plugins inspect myplugin
See code: @oclif/plugin-plugins
almic plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ almic 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
$ almic plugins add
EXAMPLES
$ almic plugins install myplugin
$ almic plugins install https://github.com/someuser/someplugin
$ almic plugins install someuser/someplugin
See code: @oclif/plugin-plugins
almic plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ almic 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
$ almic plugins link myplugin
See code: @oclif/plugin-plugins
almic plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ almic 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
$ almic plugins unlink
$ almic plugins remove
EXAMPLES
$ almic plugins remove myplugin
almic plugins reset
Remove all user-installed and linked plugins.
USAGE
$ almic plugins reset
See code: @oclif/plugin-plugins
almic plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ almic plugins uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ almic plugins unlink
$ almic plugins remove
EXAMPLES
$ almic plugins uninstall myplugin
See code: @oclif/plugin-plugins
almic plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ almic 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
$ almic plugins unlink
$ almic plugins remove
EXAMPLES
$ almic plugins unlink myplugin
almic plugins update
Update installed plugins.
USAGE
$ almic plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins