diff --git a/docs/reference/stacker_cli.md b/docs/reference/stacker_cli.md index 7624aca..f186550 100644 --- a/docs/reference/stacker_cli.md +++ b/docs/reference/stacker_cli.md @@ -1 +1,233 @@ -# Stacker CLI \ No newline at end of file +# Stacker Command-Line Interface Reference + + + + + + + + + + + + + + +
stackerStacker builds OCI images
stacker buildBuild a new OCI image from a stacker yaml file
stacker recursive-buildFind stacker yaml files under a directory and builds all OCI layers they define
stacker publishPublish OCI images previously built from one or more stacker yaml files
stacker chrootRun a command in a chroot (same as stacker exec)
stacker cleanClean up after a stacker build
stacker inspectPrint the json representation of an OCI image
stacker grabGrab a file from the layer's filesystem
stacker unpriv-setupDo the necessary unprivileged setup for stacker build to work without root
stacker gcGarbage collection of unused OCI imports/outputs snapshots
stacker checkCheck that all runtime required items (like kernel features) are present
stacker helpShow a list of commands or help for one command
+ + + +## stacker + + NAME: + stacker - stacker builds OCI images + + USAGE: + stacker [global options] command [command options] [arguments...] + + VERSION: + stacker v0.40.1-e54a685 liblxc a330126b45c7c3b6fcf0f9ba6c1eda7bdb4e508a + + COMMANDS: + build builds a new OCI image from a stacker yaml file + recursive-build finds stacker yaml files under a directory and builds all OCI layers they define + publish publishes OCI images previously built from one or more stacker yaml files + chroot, exec run a command in a chroot + clean cleans up after a `stacker build` + inspect print the json representation of an OCI image + grab grabs a file from the layer's filesystem + unpriv-setup do the necessary unprivileged setup for stacker build to work without root + gc gc unused OCI imports/outputs snapshots + check checks that all runtime required things (like kernel features) are present + help, h Shows a list of commands or help for one command + + GLOBAL OPTIONS: + --stacker-dir value set the directory for stacker's cache (default: ".stacker") + --oci-dir value set the directory for OCI output (default: "oci") + --roots-dir value set the directory for the rootfs output (default: "roots") + --config value stacker config file with defaults (default: "/users/mishield/.config/stacker/conf.yaml") + --debug enable stacker debug mode + -q, --quiet silence all logs + --log-file value log to a file instead of stderr + --log-timestamp whether to log a timestamp prefix + --storage-type value storage type (must be "overlay", left for compatibility) (default: "overlay") + --no-progress disable progress when downloading container images or files + --help, -h show help + --version, -v print the version + + + +## stacker build + + NAME: + stacker build - builds a new OCI image from a stacker yaml file + + USAGE: + stacker build [command options] [arguments...] + + OPTIONS: + --no-cache don't use the previous build cache + --substitute value variable substitution in stackerfiles, FOO=bar format + --substitute-file value file containing variable substitution in stackerfiles, 'FOO: bar' yaml format + --on-run-failure value command to run inside container if run fails (useful for inspection) + --shell-fail exec /bin/sh inside the container if run fails (alias for --on-run-failure=/bin/sh) + --layer-type value set the output layer type (supported values: tar, squashfs); can be supplied multiple times (default: "tar") + --no-squashfs-verity do not append dm-verity data to squashfs archives + --require-hash require all remote imports to have a hash provided in stackerfiles + --order-only show the build order without running the actual build + --annotations-namespace value set OCI annotations namespace in the OCI image manifest (default: "io.stackeroci") + --stacker-file value, -f value the input stackerfile (default: "stacker.yaml") + + + +## stacker recursive-build + + NAME: + stacker recursive-build - finds stacker yaml files under a directory and builds all OCI layers they define + + USAGE: + stacker recursive-build [command options] [arguments...] + + OPTIONS: + --no-cache don't use the previous build cache + --substitute value variable substitution in stackerfiles, FOO=bar format + --substitute-file value file containing variable substitution in stackerfiles, 'FOO: bar' yaml format + --on-run-failure value command to run inside container if run fails (useful for inspection) + --shell-fail exec /bin/sh inside the container if run fails (alias for --on-run-failure=/bin/sh) + --layer-type value set the output layer type (supported values: tar, squashfs); can be supplied multiple times (default: "tar") + --no-squashfs-verity do not append dm-verity data to squashfs archives + --require-hash require all remote imports to have a hash provided in stackerfiles + --order-only show the build order without running the actual build + --annotations-namespace value set OCI annotations namespace in the OCI image manifest (default: "io.stackeroci") + --stacker-file-pattern value, -p value regex pattern to use when searching for stackerfile paths (default: "\\/stacker.yaml$") + --search-dir value, -d value directory under which to search for stackerfiles to build (default: ".") + + + +## stacker publish + + NAME: + stacker publish - publishes OCI images previously built from one or more stacker yaml files + + USAGE: + stacker publish [command options] [arguments...] + + OPTIONS: + --stacker-file value, -f value the input stackerfile (default: "stacker.yaml") + --stacker-file-pattern value, -p value regex pattern to use when searching for stackerfile paths (default: "\\/stacker.yaml$") + --search-dir value, -d value directory under which to search for stackerfiles to publish + --url value url where to publish the OCI images + --username value username for the registry where the OCI images are published + --password value password for the registry where the OCI images are published + --skip-tls skip tls verify on upstream registry + --tag value tag to be used when publishing + --substitute value variable substitution in stackerfiles, FOO=bar format + --show-only show the images to be published without actually publishing them + --force force publishing the images present in the OCI layout even if they should be rebuilt + --layer-type value set the output layer type (supported values: tar, squashfs); can be supplied multiple times (default: "tar") + + + +## stacker chroot, exec + + NAME: + stacker chroot - run a command in a chroot + + USAGE: + stacker chroot [command options] [tag] [cmd] + + is the built tag in the stackerfile to chroot to, or the first tag if + none is specified. + + is the command to run, or /bin/sh if none is specified. To specify cmd, + you must specify a tag. + + OPTIONS: + --stacker-file value, -f value the input stackerfile (default: "stacker.yaml") + --substitute value variable substitution in stackerfiles, FOO=bar format + + + +## stacker clean + + NAME: + stacker clean - cleans up after a `stacker build` + + USAGE: + stacker clean [command options] [arguments...] + + OPTIONS: + --all no-op; this used to do soemthing, and is left in for compatibility + + + +## stacker inspect + + NAME: + stacker inspect - print the json representation of an OCI image + + USAGE: + stacker inspect [tag] + + is the tag in the stackerfile to inspect. If none is supplied, inspect + prints the information on all tags. + + + +## stacker grab + + NAME: + stacker grab - grabs a file from the layer's filesystem + + USAGE: + stacker grab : + + is the tag in a built stacker image to extract the file from. + + is the path to extract (relative to /) in the image's rootfs. + + + +## stacker unpriv-setup + + NAME: + stacker unpriv-setup - do the necessary unprivileged setup for stacker build to work without root + + USAGE: + stacker unpriv-setup [command options] [arguments...] + + OPTIONS: + --uid value the user to do setup for (defaults to $SUDO_UID from env) + --gid value the group to do setup for (defaults to $SUDO_GID from env) + --username value the username to do setup for (defaults to $SUDO_USER from env) + + + +## stacker gc + + NAME: + stacker gc - gc unused OCI imports/outputs snapshots + + USAGE: + stacker gc [arguments...] + + + +## stacker check + + NAME: + stacker check - checks that all runtime required things (like kernel features) are present + + USAGE: + stacker check [arguments...] + + + +## stacker help + + NAME: + - Shows a list of commands or help for one command + + USAGE: + [command] +