Package Exports
- @enspirit/emb
- @enspirit/emb/dist/src/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@enspirit/emb) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
emb (Enspirit's Monorepo Builder)
A CLI to help on Enspirit monorepos. This aims at replacing our aging Makefile for monorepos
Usage
$ npm install -g @enspirit/emb
$ emb COMMAND
running command...
$ emb (--version)
@enspirit/emb/0.0.7 darwin-x64 node-v22.12.0
$ emb --help [COMMAND]
USAGE
$ emb COMMAND
...Commands
emb autocomplete [SHELL]emb cleanemb componentsemb components build [COMPONENT]emb config printemb containersemb containers pruneemb downemb help [COMMAND]emb imagesemb images deleteemb images pruneemb psemb tasksemb tasks run TASKemb upemb update [CHANNEL]
emb autocomplete [SHELL]
Display autocomplete installation instructions.
USAGE
$ emb 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
$ emb autocomplete
$ emb autocomplete bash
$ emb autocomplete zsh
$ emb autocomplete powershell
$ emb autocomplete --refresh-cacheSee code: @oclif/plugin-autocomplete
emb clean
Clean the project.
USAGE
$ emb clean [--json] [-f]
FLAGS
-f, --force Force the deletion of containers & images
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Clean the project.
EXAMPLES
$ emb cleanemb components
List components.
USAGE
$ emb components [--json] [--flavor <value>]
FLAGS
--flavor=<value> Specify the flavor to use.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List components.
EXAMPLES
$ emb componentsemb components build [COMPONENT]
Build the components of the monorepo
USAGE
$ emb components build [COMPONENT...] [--json] [--flavor <value>] [--dry-run]
ARGUMENTS
COMPONENT... List of components to build (defaults to all)
FLAGS
--dry-run Do not build the components but only produce build meta information
--flavor=<value> Specify the flavor to use.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Build the components of the monorepo
EXAMPLES
$ emb components build build --flavor developmentemb config print
Print the current config.
USAGE
$ emb config print [--json] [--flavor <value>]
FLAGS
--flavor=<value> Specify the flavor to use.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Print the current config.
EXAMPLES
$ emb config printemb containers
List docker containers.
USAGE
$ emb containers [--json] [-a]
FLAGS
-a, --all Retun all containers. By default, only running containers are shown
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List docker containers.
ALIASES
$ emb ps
EXAMPLES
$ emb containersemb containers prune
Prune containers.
USAGE
$ emb containers prune [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Prune containers.
EXAMPLES
$ emb containers pruneemb down
Stop the whole project.
USAGE
$ emb down [--json] [--flavor <value>]
FLAGS
--flavor=<value> Specify the flavor to use.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Stop the whole project.
EXAMPLES
$ emb downemb help [COMMAND]
Display help for emb.
USAGE
$ emb 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 emb.See code: @oclif/plugin-help
emb images
List docker images.
USAGE
$ emb images [--json] [-a]
FLAGS
-a, --all Show all images. Only images from a final layer (no children) are shown by default.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List docker images.
EXAMPLES
$ emb imagesemb images delete
Delete project images.
USAGE
$ emb images delete [--json] [-f]
FLAGS
-f, --force Remove the image even if it is being used by stopped containers or has other tags
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Delete project images.
EXAMPLES
$ emb images deleteemb images prune
Prune project images.
USAGE
$ emb images prune [--json] [-a]
FLAGS
-a, --all Prune all images. When set to true all images will be pruned, not only dangling ones
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Prune project images.
EXAMPLES
$ emb images pruneemb ps
List docker containers.
USAGE
$ emb ps [--json] [-a]
FLAGS
-a, --all Retun all containers. By default, only running containers are shown
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List docker containers.
ALIASES
$ emb ps
EXAMPLES
$ emb psemb tasks
List tasks.
USAGE
$ emb tasks [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List tasks.
EXAMPLES
$ emb tasksemb tasks run TASK
Run tasks.
USAGE
$ emb tasks run TASK... [--json] [-x container|local]
ARGUMENTS
TASK... List of tasks to run. You can provide either ids or names (eg: component:task or task)
FLAGS
-x, --executor=<option> Where to run the task. (experimental!)
<options: container|local>
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Run tasks.
EXAMPLES
$ emb tasks runemb up
Start the whole project.
USAGE
$ emb up [--json] [--flavor <value>] [-f]
FLAGS
-f, --force Bypass caches, force the recreation of containers, etc
--flavor=<value> Specify the flavor to use.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Start the whole project.
EXAMPLES
$ emb upemb update [CHANNEL]
update the emb CLI
USAGE
$ emb update [CHANNEL] [--force | | [-a | -v <value> | -i]] [-b ]
FLAGS
-a, --available See available versions.
-b, --verbose Show more details about the available versions.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=<value> Install a specific version.
--force Force a re-download of the requested version.
DESCRIPTION
update the emb CLI
EXAMPLES
Update to the stable channel:
$ emb update stable
Update to a specific version:
$ emb update --version 1.0.0
Interactively select version:
$ emb update --interactive
See available versions:
$ emb update --availableSee code: @oclif/plugin-update