@microbackend/cli
v1.0.1
Published
Micro-backend CLI tools
Downloads
32
Readme
@microbackend/cli
The main CLI tool to be used alongside a microbackend-based project.
Installation
yarn add @microbackend/cli
yarn global add @microbackend/cli
npm install @microbackend/cli
npm install -g @microbackend/cli
Usage
microbackend --help
Usage: microbackend [options] [command]
Options:
--ignore-child-process-stdout If true, ignore child process stdout. This
does not affect the logs produced by the CLI
itself. (default: false)
--ignore-error If true, do not fail on error. (default:
false)
-h, --help display help for command
Commands:
gen [options]
init [options]
internal
plugin
help [command] display help for command
microbackend init --help
Initialize a new microbackend project.
Usage: microbackend init [options]
Options:
--dirname <dirname> The base directory of the project. (default:
current working directory)
--template <template> Specify the project template (express).
--author <author> Specify the project author.
--project-name <projectName> Specify the project name.
--port <port> Specify the default server port..
--install-canary Install canary versions of microbackend
plugins. (default: false)
-h, --help display help for command
microbackend plugin --help
Plugin-related functionalities.
Usage: microbackend plugin [options] [command]
Options:
-h, --help display help for command
Commands:
add [options] <pluginToAdd> [pluginsToAdd...]
upgrade [options]
help [command] display help for command
microbackend plugin add --help
Add a new microbackend plugin.
Usage: microbackend plugin add [options] <pluginToAdd> [pluginsToAdd...]
Options:
--dirname <dirname> The base directory of the project. (default: current
working directory)
--install-canary Install canary versions of microbackend plugins.
(default: false)
-h, --help display help for command
microbackend plugin upgrade --help
Upgrade microbackend plugins to latest versions.
Usage: microbackend plugin upgrade [options]
Options:
--dirname <dirname> The base directory of the project. (default: current
working directory)
--install-canary Install canary versions of microbackend plugins.
(default: false)
-h, --help display help for command
microbackend gen --help
Generate the necessary types and files for a microbackend-based project.
Usage: microbackend gen [options]
Options:
--dirname <dirname> The base directory of the project. (default: current
working directory)
-h, --help display help for command