UNPKG

@enspirit/emb

Version:

A replacement for our Makefile-for-monorepos

857 lines 21.5 kB
{ "commands": { "clean": { "aliases": [], "args": {}, "description": "Clean the project.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Force the deletion of containers & images", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "clean", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "clean.js" ] }, "down": { "aliases": [], "args": {}, "description": "Stop the whole project.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flavor": { "description": "Specify the flavor to use.", "name": "flavor", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "down", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "down.js" ] }, "restart": { "aliases": [], "args": { "component": { "description": "The component(s) to restart", "name": "component" } }, "description": "Restart the whole project.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "no-deps": { "char": "f", "description": "Don't restart depdendent components", "name": "no-deps", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "restart", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "strict": false, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "restart.js" ] }, "stop": { "aliases": [], "args": {}, "description": "Stop the whole project.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flavor": { "description": "Specify the flavor to use.", "name": "flavor", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "stop", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "stop.js" ] }, "up": { "aliases": [], "args": { "component": { "description": "The component(s) to build and start", "name": "component" } }, "description": "Start the whole project.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flavor": { "description": "Specify the flavor to use.", "name": "flavor", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Bypass caches, force the recreation of containers, etc", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "up", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "strict": false, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "up.js" ] }, "components": { "aliases": [], "args": {}, "description": "List components.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flavor": { "description": "Specify the flavor to use.", "name": "flavor", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "components", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "components", "index.js" ] }, "components:logs": { "aliases": [ "logs" ], "args": { "component": { "description": "The component you want to see the logs of", "name": "component", "required": true } }, "description": "Get components logs.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "follow": { "char": "f", "description": "Follow log output", "name": "follow", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "components:logs", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "components", "logs.js" ] }, "components:shell": { "aliases": [ "shell" ], "args": { "component": { "description": "The component you want to get a shell on", "name": "component", "required": true } }, "description": "Get a shell on a running component.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "shell": { "char": "s", "description": "The shell to run", "name": "shell", "default": "bash", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "components:shell", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "components", "shell.js" ] }, "config:print": { "aliases": [], "args": {}, "description": "Print the current config.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flavor": { "description": "Specify the flavor to use.", "name": "flavor", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "config:print", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "config", "print.js" ] }, "containers": { "aliases": [ "ps" ], "args": {}, "description": "List docker containers.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "all": { "char": "a", "description": "Retun all containers. By default, only running containers are shown", "name": "all", "required": false, "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "containers", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "containers", "index.js" ] }, "containers:prune": { "aliases": [], "args": {}, "description": "Prune containers.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "containers:prune", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "containers", "prune.js" ] }, "images:delete": { "aliases": [], "args": {}, "description": "Delete project images.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Remove the image even if it is being used by stopped containers or has other tags", "name": "force", "required": false, "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "images:delete", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "images", "delete.js" ] }, "images": { "aliases": [], "args": {}, "description": "List docker images.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flavor": { "description": "Specify the flavor to use.", "name": "flavor", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "all": { "char": "a", "description": "Show all images. Only images from a final layer (no children) are shown by default.", "name": "all", "required": false, "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "images", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "images", "index.js" ] }, "images:prune": { "aliases": [], "args": {}, "description": "Prune project images.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "all": { "char": "a", "description": "Prune all images. When set to true all images will be pruned, not only dangling ones", "name": "all", "required": false, "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "images:prune", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "images", "prune.js" ] }, "images:push": { "aliases": [], "args": {}, "description": "Push docker images.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --registry my.registry.io --retag newtag" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flavor": { "description": "Specify the flavor to use.", "name": "flavor", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "registry": { "description": "Override the registry to push to", "name": "registry", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "retag": { "description": "Override the original tag to push to a new tag", "name": "retag", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "images:push", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "images", "push.js" ] }, "resources:build": { "aliases": [], "args": { "component": { "description": "List of resources to build (defaults to all)", "name": "component", "required": false } }, "description": "Build the resources of the monorepo", "examples": [ "<%= config.bin %> <%= command.id %> build --flavor development" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flavor": { "description": "Specify the flavor to use.", "name": "flavor", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dry-run": { "description": "Do not build the resources but only produce build meta information", "name": "dry-run", "required": false, "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Bypass the cache and force the build", "name": "force", "required": false, "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "resources:build", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "strict": false, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "resources", "build.js" ] }, "resources": { "aliases": [], "args": {}, "description": "List resources.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flavor": { "description": "Specify the flavor to use.", "name": "flavor", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "resources", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "resources", "index.js" ] }, "tasks": { "aliases": [], "args": {}, "description": "List tasks.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tasks", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "tasks", "index.js" ] }, "tasks:run": { "aliases": [ "run" ], "args": { "task": { "description": "List of tasks to run. You can provide either ids or names (eg: component:task or task)", "name": "task", "required": true } }, "description": "Run tasks.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "executor": { "char": "x", "description": "Where to run the task. (experimental!)", "name": "executor", "hasDynamicHelp": false, "multiple": false, "options": [ "container", "local" ], "type": "option" }, "all-matching": { "char": "a", "description": "Run all tasks matching (when multiple matches)", "name": "all-matching", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tasks:run", "pluginAlias": "@enspirit/emb", "pluginName": "@enspirit/emb", "pluginType": "core", "strict": false, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "src", "cli", "commands", "tasks", "run.js" ] } }, "version": "0.7.0" }