CloudKat's dotfiles

Dotfiles setup

Table of Contents

• Project Structure
• Installation
• Caveats
• Motivation
• 🔖 Documentation
  • Evaluate Tools
  • ®️ Emojies
  • Commands
• #️⃣ TODO
• Awailable Commands
• GPG keys
  • 📝 Guidelines
• 🔖 License
• How to Contribute
• Authors

Project Structure

.
├── bin
├── brew
├── docs
├── git
│   ├── gitattributes
│   ├── gitcfg
│   ├── gitconfig
│   └── gitconfig.include
├── locals
├── py
├── scripts
├── shell
├── terminal
│   ├── iTerm
│   ├── starship
│   └── zellij
├── tools               # gnupg, vim, browser, os, mise, and other tool configs
├── vendor
├── zsh
├── LICENSE
├── Makefile
├── mise.toml
└── README.md

Installation

Warning: If you want to give these dotfiles a try, you should first fork this repository, review the code, and remove things you don’t want or need. Don’t blindly use my settings unless you know what that entails. Use at your own risk!

Symlinks are installed via mise: bin/install runs mise bootstrap dotfiles apply against the [dotfiles] table in mise.toml. This replaces Dotbot, which this repo used previously.

mise also manages the rest of the machine bootstrap from the same mise.toml:

• make mise-install installs the dev tools pinned in tools/mise/config.toml (node, go, ...); make mise-lock-global regenerates their lockfile/checksums (tools/mise/mise.lock).
• make macos-defaults-status shows drift between mise.toml's [bootstrap.macos.*] tables and the machine's current macOS preferences; make macos-defaults-apply writes them for real.

Caveats

These scripts are meant to run only on OS X

Motivation

• ThoughBot
• Dotfiles
• Dotfiles: awesome

🔖 Documentation

• Bash Hacks
• Tools and guides
• debug
• Go module upgrades

Evaluate Tools

• Cyberduck

®️ Emojies

• Emoji: github

Commands

git check-ignore -v tools/claude/plans/

#️⃣ TODO

• ✅ ZSH (zsh-config)
• ✅ Tmuxp configuration (tmux-config) path = vendor/tmux-config
• ✅ Docker RMI alias
• ✅ Badges
• ✅ Github Hooks
• ✅ Move configs to own folders
• ✅ Install powerline fonts
• ✅ wgetrc & curlrc
• ✅ Pyenv correct setup
• ✅ Proper configre macup
• ✅ Tmux configs Setup/Document
• ✅ macOS setup docs
• Speed up shell
• ZSH plugins https://github.com/zsh-users/zsh-autosuggestions/tree/master?tab=readme-ov-file
• POV Yadm: dotfiles manager
• Firefox auto config docs
• Hammersppoon config opensource docs
• Chezmoi integration
• Support Linux/Debian
• DNS Crypt
• Document github setup, blog it as well
• Templated dotfiles (mise supports mode = "template" natively now, no plugin needed - just not adopted anywhere yet)
• Review new Terminal Options

Awailable Commands

$ make help
Usage: make [target] [VARIABLE=value]
Targets:
install                        Install dotfiles without running shell
install-all                    Install all dotfiles
brew-install                   Install apps with Brew
osx-install                    Install macOSx
macos-defaults-status          Show drift between mise.toml and current macOS defaults
macos-defaults-apply           Apply macOS defaults from mise.toml (writes real system prefs)
mise-install                   Install tools from mise.toml (node, go, ...)
mise-lock-global               Regenerate the global mise.lock (tools/mise/mise.lock)
hooks                          Setup pre commit.
validate                       Validate files with pre-commit hooks
ignore-dirty                   Ignore dirty commits
install-deps                   Install dependencies
git-submodule                  Git submodules update
git-module-remove              Remove submodule MODULE=something
open                           Open repository

GPG keys

• How to
• How to v2
• How to test

📝 Guidelines

• 📝 Use a succinct title and description.
• 🦠 Bugs & feature requests can be be opened
• 📶 Support questions are better asked on Stack Overflow
• 😊 Be nice, civil and polite (as always).

🔖 License

Copyright 2019 Ivan Katliarhcuk

MIT Licensed. See LICENSE for full details.

How to Contribute

Submit a pull request

Authors

Currently maintained by Ivan Katliarchuk and these awesome contributors.