https://github.com/ngscheurich/dotfiles
🎒 Everything I need to set up camp
https://github.com/ngscheurich/dotfiles
chezmoi dotfiles fish neovim tmux
Last synced: about 2 months ago
JSON representation
🎒 Everything I need to set up camp
- Host: GitHub
- URL: https://github.com/ngscheurich/dotfiles
- Owner: ngscheurich
- License: mit
- Created: 2013-12-02T16:34:51.000Z (almost 12 years ago)
- Default Branch: main
- Last Pushed: 2025-08-27T19:27:05.000Z (about 2 months ago)
- Last Synced: 2025-08-28T02:27:14.412Z (about 2 months ago)
- Topics: chezmoi, dotfiles, fish, neovim, tmux
- Language: Lua
- Homepage:
- Size: 1.1 MB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dotfiles
This repository contains everything I need to set up and maintain a personalized computer system. Wanderers beware: this place is ever-evolving and fraught with great peril.
## Prelude
_Computers, huh?_ Who would have thought? And yet, here we are. These are my setup and configuration files.
I’ve published them here so that folks such as you or future I might extract some wisdom from them, or perhaps just be humorously confounded. Your mileage, as they say, may vary. Also, this proves a handy place to back them up so I can pull them down onto new machines.
The files are managed with [chezmoi] and can be initialized on a new machine with [init.sh].
## Contents
I track the configuration for a wide assortment of CLI/TUI tools, but a subset of those are truly essential to my daily workflow. The configs for these come to mind, and may be worth a look:
- 🛠️ [Neovim], the hyperextensible Vim-based text editor ([config](home/dot_config/nvim))
- 🍱 [tmux], a terminal multiplexer ([config](home/dot_config/tmux))
- 🐟 [Fish], a command line shell for the 90s ([config](home/dot_config/fish))
- 👻 [Ghostty], a fast, feature-rich, terminal emulator ([config](home/dot_config/ghostty))
## Quickstart
Getting a new system up and running is just a `curl` away:
```sh
bash -c "$(curl -fsLS https://raw.githubusercontent.com/ngscheurich/dotfiles/main/init.sh)"
```
### What this script does
This is an automation script that helps me install and configure the programs I rely on. Namely, it:
1. Installs dependencies for this script to run
2. Installs chezmoi
3. Ensures a [1Password] user is active (for chezmoi templates)
4. Initializes and applies my current chezmoi state
Additionally, if the platform is [Darwin] (macOS), a couple of additional programs are installed:
- macOS command line developer tools
- [Homebrew]
### Idempotency
The script attempts to skip work that is unnecessary or has already been completed, so don't be (too) wary about running it multiple times.
### Cleanup
The script will make a temporary directory for any files it needs to create or download, and it will try to clean it up.
## Afterwards
Once you’re settled in, you might consider adding a bit more gear to your pack.
📖 How about some [useful incantations]?
```sh
bash -c "$(curl -fsLS https://raw.githubusercontent.com/ngscheurich/grimoire/main/init.sh)"
```
🎨 Perhaps you’d fancy a bit [more color] in your life?
```sh
bash -c "$(curl -fsLS https://raw.githubusercontent.com/ngscheurich/themes/main/init.sh)"
```
[1password]: https://1password.com/
[chezmoi]: https://www.chezmoi.io/
[fish]: https://fishshell.com/
[ghostty]: https://ghostty.org/
[homebrew]: https://brew.sh/
[init.sh]: init.sh
[more color]: https://github.com/ngscheurich/themes
[neovim]: https://neovim.io/
[tmux]: https://github.com/tmux/tmux/wiki
[useful incantations]: https://github.com/ngscheurich/grimoire