Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jerboa88/dotfiles
There's no place like $HOME. My dotfiles, managed with Chezmoi
https://github.com/jerboa88/dotfiles
chezmoi config configuration dotfiles dotfiles-linux linux
Last synced: about 2 months ago
JSON representation
There's no place like $HOME. My dotfiles, managed with Chezmoi
- Host: GitHub
- URL: https://github.com/jerboa88/dotfiles
- Owner: jerboa88
- License: mit
- Created: 2024-02-08T00:52:28.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-15T19:37:22.000Z (10 months ago)
- Last Synced: 2024-12-17T06:36:33.317Z (about 2 months ago)
- Topics: chezmoi, config, configuration, dotfiles, dotfiles-linux, linux
- Language: Shell
- Homepage: https://johng.io/p/dotfiles
- Size: 33.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Dotfiles
There's no place like $HOME. My dotfiles, managed with Chezmoi
## Installation
> [!NOTE]
> If you want to customize this setup to suit your needs, I'd recommend forking this repo and then replacing `jerboa88` with your own GitHub username in the commands below
1. Run `sh -c "$(curl -fsLS get.chezmoi.io/lb)" -- init --apply jerboa88` to install [Chezmoi](https://www.chezmoi.io/) and clone the dotfiles repo. If you already have Chezmoi installed, use `chezmoi init --apply jerboa88` instead.
2. Make a copy of your existing dotfiles in case you want to revert changes
3. See the differences between the repo and your home directory with `chezmoi diff`.
4. If you are okay with the changes, you can apply them to your home directory with `chezmoi apply -v`
## Usage
See the [Chezmoi docs](https://www.chezmoi.io/quick-start/) for more detailed instructions.
### Making local changes
#### Adding files
Use `chezmoi add YOUR_FILE_HERE` to add a new file to the repo. Chezmoi will make a copy of the file in `~/.local/share/chezmoi` which can then be edited or uploaded like you'd expect.
#### Editing files
I would recommend navigating to the Chezmoi directory (`~/.local/share/chezmoi`) with `chezmoi cd` and editing your files there so Chezmoi can automatically keep track of your changes. Editing files directly in your home directory is possible but it involves extra steps.
#### Applying changes
When you edit a file in the Chezmoi directory, changes are not immediately applied to your home directory.
1. Use `chezmoi diff` to compare your home directory with the Chezmoi repo to see what changes will be applied
1. Use `chezmoi apply -v` to actually apply the changes to your home directory
### Downloading changes
Use `chezmoi update -v` to pull changes from the remote repo and apply them to your home directory
### Uploading changes
Navigate to the Chezmoi directory with `chezmoi cd` and use standard git commands to push your changes to the remote repo.
For example:
```
git add YOUR_FILE_HERE
git commit -m "Your commit message here"
git push
```
## License
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.