You can generate Go documentation for chezmoi's source code with go doc, for
example:
$ go doc -all -u github.com/twpayne/chezmoi/v2/internal/chezmoi
+go doc -all -u github.com/twpayne/chezmoi/v2/internal/chezmoi
You can also browse chezmoi's generated documentation
online.
@@ -8855,7 +8855,7 @@ Testing
with the test scripts themselves in
internal/cmd/testdata/scripts/$TEST_NAME.txtar.
You can run individual end-to-end tests with
-$ go test ./internal/cmd -run=TestScript/$TEST_NAME
+go test ./internal/cmd -run=TestScript/$TEST_NAME
Tests should, if at all possible, run unmodified on all operating systems
tested in CI (Linux, macOS, Windows, and FreeBSD). Windows will sometimes need
@@ -8896,7 +8896,7 @@
Testing
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/developer-guide/building-on-top-of-chezmoi/index.html b/developer-guide/building-on-top-of-chezmoi/index.html
index d6828d6c0cb..ac4ad0e1669 100644
--- a/developer-guide/building-on-top-of-chezmoi/index.html
+++ b/developer-guide/building-on-top-of-chezmoi/index.html
@@ -8541,7 +8541,7 @@ Building on top of chezmoi
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/developer-guide/contributing-changes/index.html b/developer-guide/contributing-changes/index.html
index e6791d2b360..f8590eeb462 100644
--- a/developer-guide/contributing-changes/index.html
+++ b/developer-guide/contributing-changes/index.html
@@ -8588,7 +8588,7 @@ Contributing changes
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/developer-guide/index.html b/developer-guide/index.html
index 7033dee4613..4fe10a3df39 100644
--- a/developer-guide/index.html
+++ b/developer-guide/index.html
@@ -8503,14 +8503,14 @@ Developer guide
GitHub. chezmoi is a standard Go project, using standard
Go tooling. chezmoi requires Go 1.23 or later.
Checkout chezmoi:
-$ git clone https://github.com/twpayne/chezmoi.git
-$ cd chezmoi
+git clone https://github.com/twpayne/chezmoi.git
+cd chezmoi
Build chezmoi:
-$ go build
+go build
Run all tests:
-$ go test ./...
+go test ./...
chezmoi's tests include integration tests with other software. If the other
software is not found in $PATH the tests will be skipped. Running the full set
@@ -8518,13 +8518,13 @@
Developer guide
perl, python3, rage, ruby, sed, sha256sum, tr, true, unzip,
xz, zip, and zstd.
Run chezmoi:
-$ go run .
+go run .
Run a set of smoke tests, including cross-compilation, tests, and linting:
-$ make smoke-test
+make smoke-test
Test building chezmoi for all architectures:
-$ make test-release
+make test-release
Hint
@@ -8536,9 +8536,9 @@ Developer guide
warning-path: Please set $HOME to a directory where you have write access.
These can be avoided with by running tests with SHELL=bash or SHELL=zsh:
-$ SHELL=bash make test
-$ SHELL=zsh make smoke-test
-$ SHELL=bash go test ./...
+SHELL=bash make test
+SHELL=zsh make smoke-test
+SHELL=bash go test ./...
@@ -8576,7 +8576,7 @@ Developer guide
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/developer-guide/install-script/index.html b/developer-guide/install-script/index.html
index 4600636b5e1..2a0de0ef479 100644
--- a/developer-guide/install-script/index.html
+++ b/developer-guide/install-script/index.html
@@ -8504,7 +8504,7 @@ Install script
chezmoi generates the install
script
from a single source of truth. You must run
-$ go generate
+go generate
if your change includes any of the following:
@@ -8553,7 +8553,7 @@ Install script
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/developer-guide/packaging/index.html b/developer-guide/packaging/index.html
index aec3fe8c412..b6113078144 100644
--- a/developer-guide/packaging/index.html
+++ b/developer-guide/packaging/index.html
@@ -8592,7 +8592,7 @@ Packaging
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/developer-guide/releases/index.html b/developer-guide/releases/index.html
index aeda7122bba..74a58eef1e6 100644
--- a/developer-guide/releases/index.html
+++ b/developer-guide/releases/index.html
@@ -8597,15 +8597,15 @@ Releases
Testing
To build a test release, without publishing, (Ubuntu Linux only) first ensure
that the musl-tools and snapcraft packages are installed:
-$ sudo apt-get install musl-tools snapcraft
+sudo apt-get install musl-tools snapcraft
Then run:
-$ make test-release
+make test-release
Publishing
Publish a new release by creating and pushing a tag, for example:
-$ git tag v1.2.3
-$ git push --tags
+git tag v1.2.3
+git push --tags
This triggers a GitHub Action
that builds and publishes archives, packages, and snaps, creates a new GitHub
@@ -8618,7 +8618,7 @@ Publishing
secret.
Snapcraft store credentials periodically expire. Create new snapcraft store
credentials by running:
-$ snapcraft export-login --snaps=chezmoi --channels=stable,candidate,beta,edge --acls=package_upload -
+snapcraft export-login --snaps=chezmoi --channels=stable,candidate,beta,edge --acls=package_upload -
@@ -8628,7 +8628,7 @@ Publishing
github.com/Homebrew/homebrew-core
to bump the version.
If needed, the pull request can be created with:
-$ brew bump-formula-pr --tag=v1.2.3 chezmoi
+brew bump-formula-pr --tag=v1.2.3 chezmoi
@@ -8705,7 +8705,7 @@ Signing
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/developer-guide/security/index.html b/developer-guide/security/index.html
index b26c0f75023..50f2ee9edd1 100644
--- a/developer-guide/security/index.html
+++ b/developer-guide/security/index.html
@@ -8642,7 +8642,7 @@ Reporting a vulnerability
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/developer-guide/testing/index.html b/developer-guide/testing/index.html
index 143938bf8f8..47f828a627c 100644
--- a/developer-guide/testing/index.html
+++ b/developer-guide/testing/index.html
@@ -8564,7 +8564,7 @@ Testing
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/developer-guide/using-make/index.html b/developer-guide/using-make/index.html
index 28e555988e9..eb7bfc890e9 100644
--- a/developer-guide/using-make/index.html
+++ b/developer-guide/using-make/index.html
@@ -8584,7 +8584,7 @@ Building and installing with ma
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/developer-guide/website/index.html b/developer-guide/website/index.html
index ad2ef4aaf68..dee8f7ddae9 100644
--- a/developer-guide/website/index.html
+++ b/developer-guide/website/index.html
@@ -8568,20 +8568,20 @@ Website
uv:
If Python 3.10 (or later) is not currently installed, install it with uv:
-$ uv python install 3.10
+uv python install 3.10
Install the dependencies (the --frozen is optional but recommended):
-$ uv sync --frozen
+uv sync --frozen
Test the website locally by running:
-$ uv run task serve-docs
+uv run task serve-docs
and visiting http://127.0.0.1:8000/.
Maintainers
The website is automatically deployed when new releases are created, but manual
deployments can be triggered by maintainers with appropriate access using:
-$ uv run task mkdocs gh-deploy
+uv run task mkdocs gh-deploy
@@ -8618,7 +8618,7 @@ Maintainers
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/get b/get
index 263c712605d..d7c9f7870c7 100644
--- a/get
+++ b/get
@@ -23,7 +23,7 @@ ${this}: download chezmoi and optionally run chezmoi
Usage: ${this} [-b bindir] [-d] [-t tag] [chezmoi-args]
-b sets the installation directory, default is ${BINDIR}.
-d enables debug logging.
- -t sets the tag, default is ${TAG}.
+ -t sets the tag, default is ${TAGARG}.
If chezmoi-args are given, after install chezmoi is executed with chezmoi-args.
EOF
exit 2
diff --git a/getlb b/getlb
index dc656a49d63..a1b2f410cf5 100644
--- a/getlb
+++ b/getlb
@@ -23,7 +23,7 @@ ${this}: download chezmoi and optionally run chezmoi
Usage: ${this} [-b bindir] [-d] [-t tag] [chezmoi-args]
-b sets the installation directory, default is ${BINDIR}.
-d enables debug logging.
- -t sets the tag, default is ${TAG}.
+ -t sets the tag, default is ${TAGARG}.
If chezmoi-args are given, after install chezmoi is executed with chezmoi-args.
EOF
exit 2
diff --git a/index.html b/index.html
index cd5eeb7c661..6e953063b19 100644
--- a/index.html
+++ b/index.html
@@ -8543,7 +8543,7 @@
chezmoi
Manage your dotfiles across multiple diverse machines, securely.
-The latest version of chezmoi is 2.57.0 (release notes, release history).
+The latest version of chezmoi is 2.58.0 (release notes, release history).
What does chezmoi do?
chezmoi helps you manage your personal configuration files (dotfiles, like
~/.gitconfig) across multiple machines.
@@ -8559,12 +8559,12 @@ What does chezmoi do?
With chezmoi, pronounced /ʃeɪ mwa/ (shay-mwa), you can install chezmoi and your
dotfiles from your GitHub dotfiles repo on a new, empty machine with a single
command:
-$ sh -c "$(curl -fsLS get.chezmoi.io)" -- init --apply $GITHUB_USERNAME
+sh -c "$(curl -fsLS get.chezmoi.io)" -- init --apply $GITHUB_USERNAME
As well as the curl | sh installation, you can install chezmoi with your
favorite package manager.
Updating your dotfiles on any machine is a single command:
-$ chezmoi update
+chezmoi update
chezmoi runs on all popular operating systems, is distributed as a single
statically-linked binary with no dependencies, and does not require root access.
@@ -8633,7 +8633,7 @@ I like chezmoi. How do I say thanks?
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/install/index.html b/install/index.html
index 93346004341..a93d9710352 100644
--- a/install/index.html
+++ b/install/index.html
@@ -8647,7 +8647,7 @@
Install
-The latest version of chezmoi is 2.57.0 (release notes, release history).
+The latest version of chezmoi is 2.58.0 (release notes, release history).
One-line package install
Install chezmoi with your package manager with a single command:
@@ -8732,7 +8732,7 @@ One-line package install
-asdf plugin add chezmoi && asdf install chezmoi 2.57.0
+asdf plugin add chezmoi && asdf install chezmoi 2.58.0
@@ -8802,56 +8802,56 @@ Download a pre-built Linux package
-amd64
-arm64
-armel
-i386
-loong64
-mips64
-mips64le
-ppc64
-ppc64le
-riscv64
-s390x
+amd64
+arm64
+armel
+i386
+loong64
+mips64
+mips64le
+ppc64
+ppc64le
+riscv64
+s390x
-aarch64
-armhfp
-i686
-loong64
-mips64
-mips64le
-ppc64
-ppc64le
-s390x
-riscv64
-x86_64
+aarch64
+armhfp
+i686
+loong64
+mips64
+mips64le
+ppc64
+ppc64le
+s390x
+riscv64
+x86_64
@@ -8861,72 +8861,72 @@ Download a pre-built binary
-amd64
-arm
-arm64
-i386
-loong64
-mips64
-mips64le
-ppc64
-ppc64le
-riscv64
-s390x
-amd64 (glibc)
-amd64 (musl)
-arm64 (Termux)
+amd64
+arm
+arm64
+i386
+loong64
+mips64
+mips64le
+ppc64
+ppc64le
+riscv64
+s390x
+amd64 (glibc)
+amd64 (musl)
+arm64 (Termux)
Install from source
Download, build, and install chezmoi for your system with Go 1.23 or later:
-$ git clone https://github.com/twpayne/chezmoi.git
-$ cd chezmoi
-$ make install-from-git-working-copy
+git clone https://github.com/twpayne/chezmoi.git
+cd chezmoi
+make install-from-git-working-copy
Verify your download
-chezmoi's release process signs the SHA256 checksums of all released
+chezmoi's release process signs the SHA256 checksums of all released
assets with
cosign.
To verify an asset that you have downloaded:
-Download the checksum
-file, checksum file
-signature, and public signing
+Download the checksum
+file, checksum file
+signature, and public signing
key.
-$ curl --location --remote-name-all \
- https://github.com/twpayne/chezmoi/releases/download/v2.57.0/chezmoi_2.57.0_checksums.txt \
- https://github.com/twpayne/chezmoi/releases/download/v2.57.0/chezmoi_2.57.0_checksums.txt.sig \
- https://github.com/twpayne/chezmoi/releases/download/v2.57.0/chezmoi_cosign.pub
+curl --location --remote-name-all \
+ https://github.com/twpayne/chezmoi/releases/download/v2.58.0/chezmoi_2.58.0_checksums.txt \
+ https://github.com/twpayne/chezmoi/releases/download/v2.58.0/chezmoi_2.58.0_checksums.txt.sig \
+ https://github.com/twpayne/chezmoi/releases/download/v2.58.0/chezmoi_cosign.pub
Verify the signature of the checksum file with cosign.
-$ cosign verify-blob --key=chezmoi_cosign.pub \
- --signature=chezmoi_2.57.0_checksums.txt.sig \
- chezmoi_2.57.0_checksums.txt
+cosign verify-blob --key=chezmoi_cosign.pub \
+ --signature=chezmoi_2.58.0_checksums.txt.sig \
+ chezmoi_2.58.0_checksums.txt
Important
@@ -8938,11 +8938,11 @@ Verify your download
-$ sha256sum --check chezmoi_2.57.0_checksums.txt --ignore-missing
+sha256sum --check chezmoi_2.58.0_checksums.txt --ignore-missing
-$ shasum --algorithm 256 --check chezmoi_2.57.0_checksums.txt --ignore-missing
+shasum --algorithm 256 --check chezmoi_2.58.0_checksums.txt --ignore-missing
@@ -8984,7 +8984,7 @@ Verify your download
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/license/index.html b/license/index.html
index 22eb0794598..743497f8999 100644
--- a/license/index.html
+++ b/license/index.html
@@ -8497,7 +8497,7 @@
License
The MIT License (MIT)
-Copyright (c) 2018-2024 Tom Payne
+Copyright (c) 2018-2025 Tom Payne
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
@@ -8548,7 +8548,7 @@
License
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/links/articles/index.html b/links/articles/index.html
index d7f606a764f..7ce98722e12 100644
--- a/links/articles/index.html
+++ b/links/articles/index.html
@@ -9212,7 +9212,7 @@ Articles
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/links/dotfile-repos/index.html b/links/dotfile-repos/index.html
index f93ffd51091..3cc63896096 100644
--- a/links/dotfile-repos/index.html
+++ b/links/dotfile-repos/index.html
@@ -8547,7 +8547,7 @@ Dotfile repos
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/links/podcasts/index.html b/links/podcasts/index.html
index 706497778b6..ebcbfd4493a 100644
--- a/links/podcasts/index.html
+++ b/links/podcasts/index.html
@@ -8618,7 +8618,7 @@ Podcasts
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/links/related-software/index.html b/links/related-software/index.html
index 8f210ac1dee..dcc441cd6e6 100644
--- a/links/related-software/index.html
+++ b/links/related-software/index.html
@@ -8920,7 +8920,7 @@ install.doctor
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/links/social-media/index.html b/links/social-media/index.html
index 73e4f89706c..60123092028 100644
--- a/links/social-media/index.html
+++ b/links/social-media/index.html
@@ -8566,7 +8566,7 @@ Social media
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/links/videos/index.html b/links/videos/index.html
index a73991fb952..5d835748b33 100644
--- a/links/videos/index.html
+++ b/links/videos/index.html
@@ -8519,7 +8519,7 @@ Videos
2024-11-18
2.54.0
AR
-Chezmoi, Dotfiles, Workflow, Templates and Encryption | Arabic شرح
+Chezmoi, Dotfiles, Workflow, Templates and Encryption Arabic شرح
2024-06-22
@@ -8642,7 +8642,7 @@ Videos
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/migrating-from-another-dotfile-manager/index.html b/migrating-from-another-dotfile-manager/index.html
index 9debc37f41e..80050e1b46d 100644
--- a/migrating-from-another-dotfile-manager/index.html
+++ b/migrating-from-another-dotfile-manager/index.html
@@ -8562,7 +8562,7 @@ Migrate from a dotfil
directory. If you chezmoi add such a symlink, chezmoi will add the symlink,
not the file. To assist with migrating from symlink-based systems, use the
--follow option to chezmoi add, for example:
-$ chezmoi add --follow ~/.bashrc
+chezmoi add --follow ~/.bashrc
This will tell chezmoi add that the target state of ~/.bashrc is the target
of the ~/.bashrc symlink, rather than the symlink itself. When you run
@@ -8603,7 +8603,7 @@
Migrate from a dotfil
- Copyright © Tom Payne 2018-2024
+ Copyright © Tom Payne 2018-2025
diff --git a/quick-start/index.html b/quick-start/index.html
index a4a286badb0..65c26b1bb62 100644
--- a/quick-start/index.html
+++ b/quick-start/index.html
@@ -2792,17 +2792,17 @@ Concepts
Start using chezmoi on your current machine
Assuming that you have already installed chezmoi, initialize
chezmoi with:
-$ chezmoi init
+chezmoi init
This will create a new git local repository in ~/.local/share/chezmoi where
chezmoi will store its source state. By default, chezmoi only modifies files in
the working copy.
Manage your first file with chezmoi:
-$ chezmoi add ~/.bashrc
+chezmoi add ~/.bashrc
This will copy ~/.bashrc to ~/.local/share/chezmoi/dot_bashrc.
Edit the source state:
-$ chezmoi edit ~/.bashrc
+chezmoi edit ~/.bashrc
This will open ~/.local/share/chezmoi/dot_bashrc in your $EDITOR. Make some
changes and save the file.
@@ -2813,25 +2813,25 @@ Start using chezmoi on your
for more details.
See what changes chezmoi would make:
-$ chezmoi diff
+chezmoi diff
Apply the changes:
-$ chezmoi -v apply
+chezmoi -v apply
All chezmoi commands accept the -v (verbose) flag to print out exactly what
changes they will make to the file system, and the -n (dry run) flag to not
make any actual changes. The combination -n -v is very useful if you want to
see exactly what changes would be made.
Next, open a shell in the source directory, to commit your changes:
-$ chezmoi cd
-$ git add .
-$ git commit -m "Initial commit"
+chezmoi cd
+git add .
+git commit -m "Initial commit"
Create a new repository on GitHub called dotfiles
and then push your repo:
-$ git remote add origin git@github.com:$GITHUB_USERNAME/dotfiles.git
-$ git branch -M main
-$ git push -u origin main
+git remote add origin git@github.com:$GITHUB_USERNAME/dotfiles.git
+git branch -M main
+git push -u origin main
Hint
@@ -2842,7 +2842,7 @@ Start using chezmoi on your
BitBucket, Source Hut, or any other
git hosting service.
Finally, exit the shell in the source directory to return to where you were:
-$ exit
+exit
These commands are summarized in this sequence diagram:
sequenceDiagram
@@ -2863,33 +2863,33 @@ Start using chezmoi on your
Using chezmoi across multiple machines
On a second machine, initialize chezmoi with your dotfiles repo:
-$ chezmoi init https://github.com/$GITHUB_USERNAME/dotfiles.git
+chezmoi init https://github.com/$GITHUB_USERNAME/dotfiles.git
Hint
Private GitHub repos require other
authentication methods:
-$ chezmoi init git@github.com:$GITHUB_USERNAME/dotfiles.git
+chezmoi init git@github.com:$GITHUB_USERNAME/dotfiles.git
This will check out the repo and any submodules and optionally create a chezmoi
config file for you.
Check what changes that chezmoi will make to your home directory by running:
-$ chezmoi diff
+chezmoi diff
If you are happy with the changes that chezmoi will make then run:
-$ chezmoi apply -v
+chezmoi apply -v
If you are not happy with the changes to a file then either edit it with:
-$ chezmoi edit $FILE
+chezmoi edit $FILE
Or, invoke a merge tool (by default vimdiff) to merge changes between the
current contents of the file, the file in your working copy, and the computed
contents of the file:
-$ chezmoi merge $FILE
+chezmoi merge $FILE
On any machine, you can pull and apply the latest changes from your repo with:
-$ chezmoi update -v
+chezmoi update -v
These commands are summarized in this sequence diagram:
sequenceDiagram
@@ -2906,17 +2906,17 @@ Using chezmoi across multiple ma
Set up a new machine with a single command
You can install your dotfiles on new machine with a single command:
-$ chezmoi init --apply https://github.com/$GITHUB_USERNAME/dotfiles.git
+chezmoi init --apply https://github.com/$GITHUB_USERNAME/dotfiles.git
If you use GitHub and your dotfiles repo is called dotfiles then this can be
shortened to:
-$ chezmoi init --apply $GITHUB_USERNAME
+chezmoi init --apply $GITHUB_USERNAME
Hint
Private GitHub repos require other
authentication methods:
-chezmoi init --apply git@github.com:$GITHUB_USERNAME/dotfiles.git
+chezmoi init --apply git@github.com:$GITHUB_USERNAME/dotfiles.git
This command is summarized in this sequence diagram:
@@ -2929,7 +2929,7 @@ Set up a new machine with a
Next steps
For a full list of commands run:
-$ chezmoi help
+chezmoi help
chezmoi has much more functionality. Good starting points are reading what
other people say about chezmoi, adding more dotfiles, and
@@ -2951,7 +2951,7 @@
Next steps