{{- $latestRelease := gitHubLatestRelease "twpayne/chezmoi" -}}
{{- $version := $latestRelease.Name | trimPrefix "v" -}}
# chezmoi

Manage your dotfiles across multiple diverse machines, securely.

The latest version of chezmoi is {{ $version }} ([release notes][notes],
[release history][history]).

## What does chezmoi do?

chezmoi helps you manage your personal configuration files (dotfiles, like
`~/.gitconfig`) across multiple machines.

chezmoi provides many features beyond symlinking or using a bare git repo
including:

* templates (to handle small differences between machines)
* password manager support (to store your secrets securely)
* importing files from archives (great for shell and editor plugins)
* full file encryption (using age, gpg, git-crypt, or transcrypt)
* running scripts (to handle everything else)

With chezmoi, pronounced /ʃeɪ mwa/ (shay-mwa) (listen [1][listen1] [2][listen2]
[3][listen3]), you can install chezmoi and your dotfiles from your GitHub
dotfiles repo on a new, empty machine with a single command:

```sh
sh -c "$(curl -fsLS https://get.chezmoi.io)" -- init --apply $GITHUB_USERNAME
```

As well as the `curl | sh` installation, you can [install chezmoi with your
favorite package manager][install].

Updating your dotfiles on any machine is a single command:

```sh
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.

## How do I start with chezmoi?

[Install chezmoi][install] then read the [quick start guide][quick-start]. The
[user guide][guide] covers most common tasks. For a full description, consult
the [reference][reference].

## Should I use chezmoi?

See what other people think about chezmoi by reading [articles][articles],
listening to [podcasts][podcasts], and watching [videos][videos] about chezmoi.
Read how [chezmoi compares to other dotfile managers][compares]. Explore other
people's [dotfile repos that use chezmoi][repos].

## How do I get help using chezmoi?

chezmoi has extensive documentation. First, use the search bar at the top of
this page using a few, short, and specific keywords related to your problem.

chezmoi is an open source project with tens of thousands of users, so it is very
likely that someone else has already encountered and solved your problem. Search
[chezmoi's GitHub repo][github] for issues and discussions with keywords related
to your problem.

If your question is still unanswered, please [open a GitHub issue for
support][support].

## I like chezmoi. How do I say thanks?

Please [give chezmoi a star on GitHub][star].

[Share chezmoi][share] and, if you're happy to share your public dotfiles repo,
then [tag your repo with `chezmoi`][tag].

[Contributions are very welcome][contributions] and every [bug report, support
request, and feature request][issues] helps make chezmoi better. Thank you :)

chezmoi does not accept financial contributions. Instead, please make a donation
to a charity or cause of your choice.

[articles]: /links/articles.md
[compares]: /comparison-table.md
[contributions]: /developer-guide/contributing-changes.md
[github]: https://github.com/twpayne/chezmoi
[guide]: /user-guide/setup.md
[history]: /reference/release-history.md
[install]: /install.md
[issues]: https://github.com/twpayne/chezmoi/issues
[listen1]: /voice_30-04-2025_09-20-13.ogx
[listen2]: /voice_30-04-2025_09-20-48.ogx
[listen3]: /voice_30-04-2025_09-20-56.ogx
[notes]: {{ $latestRelease.HTMLURL }}
[podcasts]: /links/podcasts.md
[quick-start]: /quick-start.md
[reference]: /reference/index.md
[repos]: /links/dotfile-repos.md
[share]: /links/social-media.md
[star]: https://github.com/twpayne/chezmoi
[support]: https://github.com/twpayne/chezmoi/issues/new?assignees=&labels=support&projects=&template=01_support_request.md&title=.
[tag]: /links/dotfile-repos.md
[videos]: /links/videos.md
