Back to Chezmoi

`archive` [*target*....]

assets/chezmoi.io/docs/reference/commands/archive.md

2.70.21.0 KB
Original Source

archive [target....]

Generate an archive of the target state, or only the targets specified. This can be piped into tar to inspect the target state.

Flags

-f, --format format

Write the archive in format. If --output is set the format is guessed from the extension, otherwise the default is tar.

Supported formats
tar
tar.gz
tgz
zip

-z, --gzip

Compress the archive with gzip. This is automatically set if the format is tar.gz or tgz and is ignored if the format is zip.

Common flags

-x, --exclude types

--8<-- "common-flags/exclude.md"

-i, --include types

--8<-- "common-flags/include.md"

--init

--8<-- "common-flags/init.md"

-P, --parent-dirs

--8<-- "common-flags/parent-dirs.md"

-r, --recursive

--8<-- "common-flags/recursive.md:default-true"

Examples

sh
chezmoi archive | tar tvf -
chezmoi archive --output=dotfiles.tar.gz
chezmoi archive --output=dotfiles.zip