{ "commands": { "build": { "aliases": [], "args": { "imageName": { "description": "Name of the output image", "name": "imageName", "required": false } }, "description": "Build an image", "examples": [ { "command": "<%= config.bin %> <%= command.id %>", "description": "Build an app with a random image-name and default builder" }, { "command": "<%= config.bin %> <%= command.id %> image-name --builder docker.io/paketobuildpacks/builder-ubi8-base", "description": "Build and app with a specific image-name and builder" }, { "command": "<%= config.bin %> <%= command.id %> backend-image-name --path https://github.com/nodeshift/mern-workshop --context-dir backend", "description": "Build an app from a remote git repository with specifying a sub-directory." }, { "command": "<%= config.bin %> <%= command.id %> image-name --builder docker.io/paketobuildpacks/builder-ubi8-base --path /path/to/app", "description": "Build an app with a specific image-name and builder with a specific local path" } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "force-color": { "description": "Force color output", "helpGroup": "GLOBAL", "name": "force-color", "allowNo": false, "type": "boolean" }, "no-color": { "description": "Disable color output", "helpGroup": "GLOBAL", "name": "no-color", "allowNo": false, "type": "boolean" }, "quiet": { "char": "q", "description": "Show less output", "helpGroup": "GLOBAL", "name": "quiet", "allowNo": false, "type": "boolean" }, "timestamps": { "description": "Enable timestamps in output", "helpGroup": "GLOBAL", "name": "timestamps", "allowNo": false, "type": "boolean" }, "verbose": { "char": "v", "description": "Show more output", "helpGroup": "GLOBAL", "name": "verbose", "allowNo": false, "type": "boolean" }, "builder": { "char": "B", "description": "Builder image", "name": "builder", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "buildpack": { "char": "b", "description": "Buildpack to use. One of:\n a buildpack by id and version in the form of '@',\n path to a buildpack directory (not supported on Windows),\n path/URL to a buildpack .tar or .tgz file, or\n a packaged buildpack image name in the form of '/[:]'\n Repeat for each buildpack in order, or supply once by comma-separated list", "name": "buildpack", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "buildpack-registry": { "char": "r", "description": "Buildpack Registry by name.", "name": "buildpack-registry", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cache": { "description": "Cache options used to define cache techniques for build process.\n - Cache as bind: 'type=;format=bind;source='\n - Cache as image (requires --publish): 'type=;format=image;name='\n - Cache as volume: 'type=;format=volume;[name=]'\n - If no name is provided, a random name will be generated.\n (default type=build;format=volume;type=launch;format=volume;)", "name": "cache", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cache-image": { "description": "Cache build layers in remote registry. Requires --publish", "name": "cache-image", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "clear-cache": { "description": "Clear image's associated cache before building", "name": "clear-cache", "allowNo": false, "type": "boolean" }, "container-runtime": { "description": "Specify container runtime to build and push your image.", "name": "container-runtime", "hasDynamicHelp": false, "multiple": false, "options": [ "docker", "podman" ], "type": "option" }, "creation-time": { "description": "Desired create time in the output image config. Accepted values are Unix timestamps (e.g., '1641013200'), or 'now'. Platform API version must be at least 0.9 to use this feature.", "name": "creation-time", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "default-process": { "char": "D", "description": "Set the default process type", "name": "default-process", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "descriptor": { "char": "d", "description": "Path to the project descriptor file", "name": "descriptor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "docker-host": { "description": "Address to docker daemon that will be exposed to the build container.\n If not set (or set to empty string) the standard socket location will be used.\n Special value 'inherit' may be used in which case DOCKER_HOST environment variable will be used.\n This option may set DOCKER_HOST environment variable for the build container if needed.", "name": "docker-host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env": { "char": "e", "description": "Build-time environment variable, in the form 'VAR=VALUE' or 'VAR'.\n When using latter value-less form, value will be taken from current\n environment at the time this command is executed.\n This flag may be specified multiple times and will override\n individual values defined by --env-file.\n Repeat for each env in order (comma-separated lists not accepted)\n NOTE: These are NOT available at image runtime.", "name": "env", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "env-file": { "description": "Build-time environment variables file\n One variable per line, of the form 'VAR=VALUE' or 'VAR'\n When using latter value-less form, value will be taken from current\n environment at the time this command is executed\n NOTE: These are NOT available at image runtime.\"", "name": "env-file", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "extension": { "description": " Extension to use. One of:\n an extension by id and version in the form of '@',\n path to an extension directory (not supported on Windows),\n path/URL to an extension .tar or .tgz file, or\n a packaged extension image name in the form of '/[:]'\n Repeat for each extension in order, or supply once by comma-separated list", "name": "extension", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "gid": { "description": "Override GID of user's group in the stack's build and run images. The provided value must be a positive number", "name": "gid", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "help": { "char": "h", "description": "Help for 'build'", "name": "help", "allowNo": false, "type": "boolean" }, "interactive": { "description": "Launch a terminal UI to depict the build process", "name": "interactive", "allowNo": false, "type": "boolean" }, "lifecycle-image": { "description": "Custom lifecycle image to use for analysis, restore, and export when builder is untrusted.", "name": "lifecycle-image", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "network": { "description": "Connect detect and build containers to network", "name": "network", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "char": "p", "description": "Path to app dir or zip-formatted file (defaults to current working directory)", "name": "path", "default": ".", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "platform": { "description": "Platform to build on (e.g., \"linux/amd64\").", "name": "platform", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "post-buildpack": { "description": "Buildpacks to append to the groups in the builder's order", "name": "post-buildpack", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "pre-buildpack": { "description": "Buildpacks to prepend to the groups in the builder's order", "name": "pre-buildpack", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "previous-image": { "description": "Set previous image to a particular tag reference, digest reference, or (when performing a daemon build) image ID", "name": "previous-image", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "publish": { "description": "Publish the application image directly to the container registry specified in , instead of the daemon. The run image must also reside in the registry.", "name": "publish", "allowNo": false, "type": "boolean" }, "pull-policy": { "description": "Pull policy to use. Accepted values are always, never, and if-not-present.", "name": "pull-policy", "default": "always", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "report-output-dir": { "description": "Path to export build report.toml.\n Omitting the flag yield no report file.", "name": "report-output-dir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "run-image": { "description": "Run image (defaults to default stack's run image)\n Omitting the flag will yield no SBoM content.", "name": "run-image", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sbom-output-dir": { "description": "Path to export SBoM contents.", "name": "sbom-output-dir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sparse": { "description": "Use this flag to avoid saving on disk the run-image layers when the application image is exported to OCI layout format", "name": "sparse", "allowNo": false, "type": "boolean" }, "tag": { "char": "t", "description": "Additional tags to push the output image to.\n Tags should be in the format 'image:tag' or 'repository/image:tag'.\n Repeat for each tag in order, or supply once by comma-separated list", "name": "tag", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "trust-builder": { "description": "Trust the provided builder.\n All lifecycle phases will be run in a single container.\n For more on trusted builders, and when to trust or untrust a builder, check out our docs here: https://buildpacks.io/docs/tools/pack/concepts/trusted_builders", "name": "trust-builder", "allowNo": false, "type": "boolean" }, "trust-extra-buildpacks": { "description": "Trust buildpacks that are provided in addition to the buildpacks on the builder", "name": "trust-extra-buildpacks", "allowNo": false, "type": "boolean" }, "uid": { "description": "Override UID of user in the stack's build and run images. The provided value must be a positive number", "name": "uid", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "volume": { "description": "Mount host volume into the build container, in the form ':[:]'.\n - 'host path': Name of the volume or absolute directory path to mount.\n - 'target path': The path where the file or directory is available in the container.\n - 'options' (default \"ro\"): An optional comma separated list of mount options.\n - \"ro\", volume contents are read-only.\n - \"rw\", volume contents are readable and writeable.\n - \"volume-opt==\", can be specified more than once, takes a key-value pair consisting of the option name and its value.\n Repeat for each volume in order (comma-separated lists not accepted)\n", "name": "volume", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "workspace": { "description": "Location at which to mount the app dir in the build image", "name": "workspace", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "build", "pluginAlias": "paicku", "pluginName": "paicku", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "build", "index.js" ] }, "builder:suggest": { "aliases": [ "builder:suggest", "builders:suggest" ], "args": {}, "description": "Display suggested builders for the given application", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "force-color": { "description": "Force color output", "helpGroup": "GLOBAL", "name": "force-color", "allowNo": false, "type": "boolean" }, "no-color": { "description": "Disable color output", "helpGroup": "GLOBAL", "name": "no-color", "allowNo": false, "type": "boolean" }, "quiet": { "char": "q", "description": "Show less output", "helpGroup": "GLOBAL", "name": "quiet", "allowNo": false, "type": "boolean" }, "timestamps": { "description": "Enable timestamps in output", "helpGroup": "GLOBAL", "name": "timestamps", "allowNo": false, "type": "boolean" }, "verbose": { "char": "v", "description": "Show more output", "helpGroup": "GLOBAL", "name": "verbose", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Help for 'builder suggest'", "name": "help", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "builder:suggest", "pluginAlias": "paicku", "pluginName": "paicku", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "builder", "suggest.js" ] }, "sbom:download": { "aliases": [], "args": { "imageName": { "description": "Download SBoM from specified image", "name": "imageName", "required": true } }, "description": "Interact with SBoM", "examples": [ "<%= config.bin %> <%= command.id %> buildpacksio/pack" ], "flags": { "force-color": { "description": "Force color output", "helpGroup": "GLOBAL", "name": "force-color", "allowNo": false, "type": "boolean" }, "no-color": { "description": "Disable color output", "helpGroup": "GLOBAL", "name": "no-color", "allowNo": false, "type": "boolean" }, "quiet": { "char": "q", "description": "Show less output", "helpGroup": "GLOBAL", "name": "quiet", "allowNo": false, "type": "boolean" }, "timestamps": { "description": "Enable timestamps in output", "helpGroup": "GLOBAL", "name": "timestamps", "allowNo": false, "type": "boolean" }, "verbose": { "char": "v", "description": "Show more output", "helpGroup": "GLOBAL", "name": "verbose", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Help for 'download'", "name": "help", "allowNo": false, "type": "boolean" }, "output-dir": { "char": "o", "description": "Path to export SBoM contents.", "name": "output-dir", "default": ".", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "description": "Download SBoM of image in remote registry (without pulling image)", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "sbom:download", "pluginAlias": "paicku", "pluginName": "paicku", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "sbom", "download.js" ] }, "inspect": { "aliases": [ "inspect", "inspect-image" ], "args": { "imageName": { "description": "Name of the image to inspect", "name": "imageName", "required": true } }, "description": "Show information about a built app image", "examples": [ "<%= config.bin %> <%= command.id %> buildpacksio/pack" ], "flags": { "force-color": { "description": "Force color output", "helpGroup": "GLOBAL", "name": "force-color", "allowNo": false, "type": "boolean" }, "no-color": { "description": "Disable color output", "helpGroup": "GLOBAL", "name": "no-color", "allowNo": false, "type": "boolean" }, "quiet": { "char": "q", "description": "Show less output", "helpGroup": "GLOBAL", "name": "quiet", "allowNo": false, "type": "boolean" }, "timestamps": { "description": "Enable timestamps in output", "helpGroup": "GLOBAL", "name": "timestamps", "allowNo": false, "type": "boolean" }, "verbose": { "char": "v", "description": "Show more output", "helpGroup": "GLOBAL", "name": "verbose", "allowNo": false, "type": "boolean" }, "bom": { "description": "print bill of materials", "name": "bom", "allowNo": false, "type": "boolean" }, "container-runtime": { "description": "Specify container runtime to inspect your image.", "name": "container-runtime", "hasDynamicHelp": false, "multiple": false, "options": [ "docker", "podman" ], "type": "option" }, "help": { "char": "h", "description": "Help for 'inspect'", "name": "help", "allowNo": false, "type": "boolean" }, "output": { "char": "o", "description": "Output format to display builder detail.", "name": "output", "default": "human-readable", "hasDynamicHelp": false, "multiple": false, "options": [ "json", "yaml", "toml", "human-readable" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "inspect", "pluginAlias": "paicku", "pluginName": "paicku", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "inspect", "index.js" ] } }, "version": "0.1.0" }