UNPKG

terrac

Version:

A minimal private module registry for Terraform and OpenTofu

188 lines 5.35 kB
{ "commands": { "get": { "aliases": [], "args": { "name": { "description": "Module name", "name": "name", "required": true }, "version": { "description": "Module version. This could be a version name (like latest), a semver, or a semver component.\nBy default, terrac will verify the release with the input version and generate the source URL.\nIf it needs to resolve to an exact version, use the --exact flag.", "name": "version", "required": false } }, "description": "Get the module source URL of the given module and version.", "examples": [ "<%= config.bin %> <%= command.id %> my-module", "<%= config.bin %> <%= command.id %> my-module latest", "<%= config.bin %> <%= command.id %> my-module 1.3.2", "<%= config.bin %> <%= command.id %> my-module 1.3", "<%= config.bin %> <%= command.id %> --exact my-module 1.3" ], "flags": { "exact": { "name": "exact", "summary": "Whether to resolve to an exact version if a named version or a semver component is given", "allowNo": false, "type": "boolean" }, "work-directory": { "name": "work-directory", "summary": "Root directory of the module configuration", "default": ".", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "overwrite-config": { "hidden": true, "name": "overwrite-config", "summary": "Overwrite terrac configuration", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "get", "pluginAlias": "terrac", "pluginName": "terrac", "pluginType": "core", "strict": true, "isESM": false, "relativePath": [ "dist", "commands", "get.js" ] }, "init": { "aliases": [], "args": {}, "description": "Initialize terrac configuration in a directory.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "work-directory": { "name": "work-directory", "summary": "Root directory of the module project", "default": ".", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "init", "pluginAlias": "terrac", "pluginName": "terrac", "pluginType": "core", "strict": true, "isESM": false, "relativePath": [ "dist", "commands", "init.js" ] }, "list": { "aliases": [], "args": { "name": { "description": "Module name", "name": "name", "required": false } }, "description": "List available modules and versions.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> my-module" ], "flags": { "work-directory": { "name": "work-directory", "summary": "Root directory of the terrac configuration", "default": ".", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "overwrite-config": { "hidden": true, "name": "overwrite-config", "summary": "Overwrite terrac configuration", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "list", "pluginAlias": "terrac", "pluginName": "terrac", "pluginType": "core", "strict": true, "isESM": false, "relativePath": [ "dist", "commands", "list.js" ] }, "publish": { "aliases": [], "args": {}, "description": "Publish a terraform module.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --overwrite" ], "flags": { "overwrite": { "name": "overwrite", "summary": "Overwrite a published version with a new package", "allowNo": false, "type": "boolean" }, "overwrite-config": { "hidden": true, "name": "overwrite-config", "summary": "Overwrite terrac configuration", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "work-directory": { "name": "work-directory", "summary": "Root directory of the module project", "default": ".", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "publish", "pluginAlias": "terrac", "pluginName": "terrac", "pluginType": "core", "strict": true, "isESM": false, "relativePath": [ "dist", "commands", "publish.js" ] } }, "version": "0.3.1" }