@chabokan.net/cli
v0.8.9
Published
Chabokan Cli for PaaS Services
Downloads
984
Maintainers
Readme
chabok
A new CLI generated with oclif
Usage
$ npm install -g @chabokan.net/cli
$ chabok COMMAND
running command...
$ chabok (--version|-v)
@chabokan.net/cli/0.8.9 darwin-arm64 node-v20.13.1
$ chabok --help [COMMAND]
USAGE
$ chabok COMMAND
...
Commands
chabok account list
chabok account remove
chabok account use
chabok autocomplete [SHELL]
chabok deploy
chabok help [COMMAND]
chabok login
chabok plugins
chabok plugins add PLUGIN
chabok plugins:inspect PLUGIN...
chabok plugins install PLUGIN
chabok plugins link PATH
chabok plugins remove [PLUGIN]
chabok plugins reset
chabok plugins uninstall [PLUGIN]
chabok plugins unlink [PLUGIN]
chabok plugins update
chabok service list
chabok service logs
chabok service resize
chabok service restart
chabok service start
chabok service stop
chabok version
chabok account list
show accounts list
USAGE
$ chabok account list [-h]
FLAGS
-h, --help Show CLI help.
DESCRIPTION
show accounts list
See code: src/commands/account/list.ts
chabok account remove
remove account from list
USAGE
$ chabok account remove [-h]
FLAGS
-h, --help Show CLI help.
DESCRIPTION
remove account from list
See code: src/commands/account/remove.ts
chabok account use
switch your default user between logged in users
USAGE
$ chabok account use [-h] [-u <value>]
FLAGS
-h, --help Show CLI help.
-u, --user=<value> default user
DESCRIPTION
switch your default user between logged in users
See code: src/commands/account/use.ts
chabok autocomplete [SHELL]
Display autocomplete installation instructions.
USAGE
$ chabok autocomplete [SHELL] [-r]
ARGUMENTS
SHELL (zsh|bash|powershell) Shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
Display autocomplete installation instructions.
EXAMPLES
$ chabok autocomplete
$ chabok autocomplete bash
$ chabok autocomplete zsh
$ chabok autocomplete powershell
$ chabok autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
chabok deploy
this command help you build and deploy your service to chabokan in easy way.
USAGE
$ chabok deploy [-h] [-p <value>] [-s <value>]
FLAGS
-h, --help Show CLI help.
-p, --path=<value> service path in your computer
-s, --service=<value> service name
DESCRIPTION
this command help you build and deploy your service to chabokan in easy way.
See code: src/commands/deploy.ts
chabok help [COMMAND]
Display help for chabok.
USAGE
$ chabok 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 chabok.
See code: @oclif/plugin-help
chabok login
login to hub.chabokan.net account
USAGE
$ chabok login [-h] [-u <value>] [-p <value>] [-t <value>]
FLAGS
-h, --help Show CLI help.
-p, --password=<value> your password
-t, --token=<value> login with api token
-u, --username=<value> your username
DESCRIPTION
login to hub.chabokan.net account
See code: src/commands/login.ts
chabok plugins
List installed plugins.
USAGE
$ chabok plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ chabok plugins
See code: @oclif/plugin-plugins
chabok plugins add PLUGIN
Installs a plugin into chabok.
USAGE
$ chabok 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 chabok.
Uses bundled npm executable to install plugins into /Users/mohammad/.local/share/cli
Installation of a user-installed plugin will override a core plugin.
Use the CHABOK_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the CHABOK_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ chabok plugins add
EXAMPLES
Install a plugin from npm registry.
$ chabok plugins add myplugin
Install a plugin from a github url.
$ chabok plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ chabok plugins add someuser/someplugin
chabok plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ chabok 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
$ chabok plugins inspect myplugin
See code: @oclif/plugin-plugins
chabok plugins install PLUGIN
Installs a plugin into chabok.
USAGE
$ chabok 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 chabok.
Uses bundled npm executable to install plugins into /Users/mohammad/.local/share/cli
Installation of a user-installed plugin will override a core plugin.
Use the CHABOK_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the CHABOK_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ chabok plugins add
EXAMPLES
Install a plugin from npm registry.
$ chabok plugins install myplugin
Install a plugin from a github url.
$ chabok plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ chabok plugins install someuser/someplugin
See code: @oclif/plugin-plugins
chabok plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ chabok 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
$ chabok plugins link myplugin
See code: @oclif/plugin-plugins
chabok plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ chabok 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
$ chabok plugins unlink
$ chabok plugins remove
EXAMPLES
$ chabok plugins remove myplugin
chabok plugins reset
Remove all user-installed and linked plugins.
USAGE
$ chabok 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
chabok plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ chabok 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
$ chabok plugins unlink
$ chabok plugins remove
EXAMPLES
$ chabok plugins uninstall myplugin
See code: @oclif/plugin-plugins
chabok plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ chabok 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
$ chabok plugins unlink
$ chabok plugins remove
EXAMPLES
$ chabok plugins unlink myplugin
chabok plugins update
Update installed plugins.
USAGE
$ chabok plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
chabok service list
show account services list
USAGE
$ chabok service list [-h]
FLAGS
-h, --help Show CLI help.
DESCRIPTION
show account services list
See code: src/commands/service/list.ts
chabok service logs
read latest logs from service
USAGE
$ chabok service logs [-h] [-s <value>]
FLAGS
-h, --help Show CLI help.
-s, --service=<value> service name
DESCRIPTION
read latest logs from service
See code: src/commands/service/logs.ts
chabok service resize
resize a service
USAGE
$ chabok service resize [-h] [-s <value>] [-r <value>] [-c <value>] [-d <value>]
FLAGS
-c, --cpu=<value> CPU
-d, --disk=<value> DISK
-h, --help Show CLI help.
-r, --ram=<value> RAM
-s, --service=<value> service name
DESCRIPTION
resize a service
See code: src/commands/service/resize.ts
chabok service restart
restart a service
USAGE
$ chabok service restart [-h] [-s <value>]
FLAGS
-h, --help Show CLI help.
-s, --service=<value> service name
DESCRIPTION
restart a service
See code: src/commands/service/restart.ts
chabok service start
start a service
USAGE
$ chabok service start [-h] [-s <value>]
FLAGS
-h, --help Show CLI help.
-s, --service=<value> service name
DESCRIPTION
start a service
See code: src/commands/service/start.ts
chabok service stop
stop a service
USAGE
$ chabok service stop [-h] [-s <value>]
FLAGS
-h, --help Show CLI help.
-s, --service=<value> service name
DESCRIPTION
stop a service
See code: src/commands/service/stop.ts
chabok version
USAGE
$ chabok version [--json] [--verbose]
FLAGS
--verbose Show additional information about the CLI.
GLOBAL FLAGS
--json Format output as json.
FLAG DESCRIPTIONS
--verbose Show additional information about the CLI.
Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
See code: @oclif/plugin-version