diff --git a/docs/getting-started.md b/docs/getting-started.md index f6d73e5f..d0e84e37 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -19,14 +19,17 @@ Using the official container images is the recommended option. This example uses `podman`, but `docker` can also be used. ```bash -# Pull the latest release -podman pull quay.io/coreos/butane:release +# Pull the container image release +podman image pull quay.io/coreos/butane:release -# Run butane using standard in and standard out -podman run -i --rm quay.io/coreos/butane:release --pretty --strict < your_config.bu > transpiled_config.ign +# Run Butane using standard input and standard output +podman container run --interactive --rm quay.io/coreos/butane:release \ + --pretty --strict < your_config.bu > transpiled_config.ign -# Run butane using files. -podman run --rm -v /path/to/your_config.bu:/config.bu:z quay.io/coreos/butane:release --pretty --strict /config.bu > transpiled_config.ign +# Run Butane using a file as input and standard output +podman container run --interactive --rm --security-opt label=disable \ + --volume ${PWD}:/pwd --workdir /pwd quay.io/coreos/butane:release \ + --pretty --strict your_config.bu > transpiled_config.ign ``` You may also add the following alias in your shell configuration: