neovimcraft github

plugins configs about

joshukraine/dotfiles

website github github
ai-agentsasdfclaude-codedotfilesfishfish-shellghosttykittylazyvimluamacosneovimneovim-configneovim-dotfilesrailsrubytmuxvimzsh
stars 379
issues 8
subscribers 5
forks 48
CREATED

UPDATED

My Dotfiles for macOS

dotfiles screenshot

🤩 Highlights

  • Neovim editor configured with LazyVim💤
  • Starship prompt
  • Shell support for both Zsh and Fish with 95% functional parity via shared configuration
  • Flexible, terminal-based dev environment with ghostty 👻 + Tmux!
  • Fast, idempotent setup with GNU Stow
  • New Mac bootstrap based on thoughtbot’s Laptop
  • Support for both Apple Silicon and Intel Macs
  • AI-assisted development with Claude Code (optional)

🗂️ Table of Contents

⚡️ Quick Setup

For first-time users: See the complete setup documentation for detailed guidance.

Make sure macOS is up to date and you have installed the required software.

Clone this repo.

git clone https://github.com/joshukraine/dotfiles.git ~/dotfiles

Read the setup script and check available options.

less ~/dotfiles/setup.sh
~/dotfiles/setup.sh --help

Preview what the setup script will do (dry-run mode).

~/dotfiles/setup.sh --dry-run

Run the setup script.

~/dotfiles/setup.sh

📚 Comprehensive Setup Documentation

For detailed guidance on installation, customization, and troubleshooting:

Guide Purpose
Setup Overview Choose the right guide for your situation
Installation Guide Complete step-by-step setup walkthrough
Usage Examples Command examples and practical scenarios
Troubleshooting Solutions for common setup issues
Customization Personalizing your dotfiles setup
Migration Guide Moving from other dotfiles or manual configs

✅ Prerequisites

The dotfiles assume you are running macOS with (at minimum) the following software pre-installed:

All of the above and more are installed with my fork of Laptop.

🌟 New Mac Bootstrap

This is what I would do if I bought a new Mac computer today. The steps below assume you have already completed the basics:

💻 1. Run my fork of thoughtbot’s Laptop

▹ github.com/joshukraine/laptop

Download the mac script:

curl --remote-name https://raw.githubusercontent.com/joshukraine/laptop/main/mac

Download .local.laptop for additional customizations:

curl --remote-name https://raw.githubusercontent.com/joshukraine/dotfiles/master/laptop/.laptop.local

Review both scripts before proceeding:

less mac

less .laptop.local

Execute the mac script:

sh mac 2>&1 | tee ~/laptop.log

I’ve made the following changes to my fork of Laptop:

  • Install asdf via git instead of Homebrew
  • Comment out Heroku-related code
  • Comment out unused Homebrew taps and formulae

It is worth noting that the Laptop script (mac) is idempotent and can be safely run multiple times to ensure a consistent baseline configuration.

⚠️ 2. Check for Stow conflicts

The dotfiles setup.sh script uses GNU Stow to symlink all the config files to your $HOME directory. If you already have an identically-named file/directory in $HOME (e.g. ~/.zshrc leftover from installing Laptop), this will cause a conflict, and Stow will (rightly) abort with an error.

The setup script will try to detect and backup these files ahead of Stow, but it’s still a good idea to check your $HOME directory as well as $HOME/.config and $HOME/.local/bin.

📍 3. Clone and setup the dotfiles

Clone

git clone https://github.com/joshukraine/dotfiles.git ~/dotfiles

Read and preview

less ~/dotfiles/setup.sh
~/dotfiles/setup.sh --help
~/dotfiles/setup.sh --dry-run  # Preview changes without applying them

Setup

~/dotfiles/setup.sh

If you do encounter Stow conflicts, resolve these and run setup again. The script is idempotent, so you can run it multiple times safely.

⚡️ 4. Install Zap

Zap describes itself as a “minimal zsh plugin manager that does what you expect.”

▹ zapzsh.com

[!IMPORTANT] After copying/pasting the install command for Zap, be sure to add the --keep flag to prevent Zap from replacing you existing .zshrc file.

🍺 5. Install remaining Homebrew packages

Review the included Brewfile and make desired adjustments.

less ~/Brewfile

Install the bundle.

brew bundle install

🛠️ 6. Complete post-install tasks

  • Launch LazyVim (nvim) and run :checkhealth. Resolve errors and warnings. Plugins should install automatically on first launch.
  • Add personal data as needed to *.local files such as ~/.gitconfig.local, ~/.laptop.local, ~/dotfiles/local/config.fish.local.
  • (Optional) Set up 1Password CLI for managing secrets.
  • (Optional) Set up 1Password SSH key management.
  • If using Fish, customize your setup by running the fish_config command.
  • Install Tmux plugins with <prefix> + I (https://github.com/tmux-plugins/tpm)

Zsh or Fish?

Having used both Zsh and Fish for several years, I’ve decided to keep my configs for both. One thing I particularly love about Fish is the concept of abbreviations over aliases. Happily, there is now zsh-abbr which brings this functionality to Zsh.

▹ Fish abbr docs

My Zsh and Fish configs have 95% functional parity via shared configuration:

  • Same prompt (Starship)
  • Identical abbreviations (250+) generated from single YAML source
  • Shared environment variables
  • Smart git functions with automatic branch detection

Ensure that you have Zsh from Homebrew. (which zsh) If not:

brew install zsh

Add Zsh (Homebrew version) to /etc/shells:

# Apple Silicon Macs:
echo /opt/homebrew/bin/zsh | sudo tee -a /etc/shells

# Intel Macs:
echo /usr/local/bin/zsh | sudo tee -a /etc/shells

# Or use this universal command:
echo $(which zsh) | sudo tee -a /etc/shells

Set it as your default shell:

chsh -s $(which zsh)

Install Zap. (Required for functional parity with Fish)

Restart your terminal.

 brew install fish

Add Fish to /etc/shells:

# Apple Silicon Macs:
echo /opt/homebrew/bin/fish | sudo tee -a /etc/shells

# Intel Macs:
echo /usr/local/bin/fish | sudo tee -a /etc/shells

# Or use this universal command:
echo $(which fish) | sudo tee -a /etc/shells

Set it as your default shell:

chsh -s $(which fish)

Restart your terminal. This will create the ~/.config and ~/.local directories if they don’t already exist.

Shared Configuration Framework

The dotfiles use a unified configuration system that eliminates duplication between Fish and Zsh shells:

Key Components

  • shared/abbreviations.yaml - Single source of truth for all 250+ abbreviations
  • shared/environment.sh and shared/environment.fish - Common environment variables
  • shared/generate-all-abbr.sh - Unified script to regenerate abbreviations for all shells
  • shared/generate-fish-abbr.sh and shared/generate-zsh-abbr.sh - Individual shell-specific generation scripts

Adding or Modifying Abbreviations

  1. Edit ~/dotfiles/shared/abbreviations.yaml

  2. Regenerate all abbreviations (from any directory):

    reload-abbr    # Available as a shell function - works from anywhere!

  3. Reload your shell configuration:

    • Fish: exec fish or open a new terminal
    • Zsh: src or open a new terminal

Manual script execution:

cd ~/dotfiles/shared
./generate-all-abbr.sh     # Updates both Fish and Zsh abbreviation files

Individual shell regeneration:

cd ~/dotfiles/shared
./generate-fish-abbr.sh    # Updates fish/.config/fish/abbreviations.fish
./generate-zsh-abbr.sh     # Updates zsh/.config/zsh-abbr/abbreviations.zsh

[!IMPORTANT] Never edit the generated abbreviation files directly - changes will be overwritten!

Smart Git Functions

The shared configuration includes intelligent git functions that automatically detect your main branch:

  • gpum - Pull from upstream main/master
  • grbm - Rebase on main/master
  • gcom - Checkout main/master
  • gbrm - Remove branches merged into main/master

These functions work with both main and master branch names automatically.

🤖 Claude Code Integration (Optional)

This project includes comprehensive Claude Code integration for AI-assisted development workflows. Using Claude Code is completely optional - all dotfiles functionality works independently.

What's Included

  • Global CLAUDE.md - Project context and coding standards for AI assistance
  • Custom slash commands - User-level commands for common development tasks
  • Workflow automation - GitHub issue fixes, PR creation, code reviews, and more

Available Commands

Command Description
/commit Create commits with clipboard workflow (no attribution)
/commit-auto Create commits with full automation (includes attribution)
/create-pr Generate comprehensive pull requests with smart issue linking
/resolve-issue Systematic GitHub issue resolution workflow
/review-pr Thorough pull request reviews with configurable depth
/setup-scratch Initialize temporary workspace for development notes
/new-project Comprehensive project setup (use after Claude Code's /init)
/update-deps Safe dependency updates with testing
/save-knowledge Capture session insights into structured knowledge base
/process-inbox Process web content into organized knowledge base entries

Getting Started with Claude Code

  1. Install Claude Code: Follow the official quickstart guide
  2. Explore commands: Run /help in any terminal to see available commands
  3. Learn more: Check the claude/ directory for detailed command documentation

Key Features

  • Issue-to-PR workflows with automatic linking and proper GitHub integration
  • Commit message standards following Conventional Commits format
  • Scratchpad management for organized development notes and planning
  • Cross-project consistency via global configuration and reusable commands

The Claude Code setup enhances but doesn't replace the core dotfiles functionality. Whether you use AI assistance or not, you'll have a fully functional development environment.

🔧 Functions and Abbreviations

This repository includes comprehensive documentation for all shell functions and abbreviations to improve maintainability and user experience.

Function Documentation

All 35+ shell functions are thoroughly documented with standardized inline comments and external reference guides:

  • Function Overview - Complete index of all functions with descriptions and categories
  • Git Functions - Smart git operations with automatic branch detection
  • Development Tools - Development utilities, navigation shortcuts, and command wrappers
  • Tmux Functions - Terminal multiplexer session management and workflows
  • System Functions - System utilities, process management, and command enhancements

Abbreviations Reference

All 289 shell abbreviations are documented with usage examples and descriptions:

  • Complete Abbreviations Reference - Comprehensive guide to all abbreviations across categories
    • UNIX commands with enhanced options
    • Git workflow shortcuts
    • Development tool shortcuts
    • Homebrew package management
    • Docker, Rails, Node.js, and more

Documentation Standards

  • Standardized Format: All functions include usage, arguments, examples, and return values
  • Cross-Shell Consistency: Identical documentation quality in both Fish and Zsh
  • Practical Examples: Real-world usage scenarios and workflow integration
  • Cross-References: Links between related functions and abbreviations

Regenerating Documentation

Function Documentation: Manually maintained with standardized inline comments and reference guides.

Abbreviation Documentation: Fully automated! Generated from shared/abbreviations.yaml:

# Regenerate everything (abbreviations + documentation)
reload-abbr

# Or manually from the dotfiles directory
~/dotfiles/shared/generate-all-abbr.sh

# Individual generators (for development)
~/dotfiles/shared/generate-fish-abbr.sh          # Fish abbreviations only
~/dotfiles/shared/generate-zsh-abbr.sh           # Zsh abbreviations only
~/dotfiles/shared/generate-abbreviations-doc.sh  # Documentation only

What gets regenerated automatically:

  • fish/.config/fish/abbreviations.fish (288 abbreviations)
  • zsh/.config/zsh-abbr/abbreviations.zsh (289 abbreviations)
  • docs/abbreviations.md (complete reference documentation)

After regeneration: Reload your shell (exec fish or src) to use new abbreviations.

Markdown Linting

This repository includes a complete markdownlint setup for consistent markdown formatting across all projects.

Features

  • Fallback Configuration Discovery: Automatically finds markdown config in multiple locations:
    • ~/dotfiles/markdown/.markdownlint-cli2.yaml (primary)
    • PWD/markdown/.markdownlint-cli2.yaml (project-specific)
    • PWD/.markdownlint-cli2.yaml (project root)
    • Falls back to legacy .markdownlint.yaml files for compatibility
  • Global Wrapper Script: markdown-validate command available system-wide
  • Shell Abbreviations: Quick access via mdl/mdv commands
  • Editor Integration: Works seamlessly with Neovim/LazyVim
  • Auto-fix Coordination: Prettier → markdownlint-cli2 tool chain

Usage

# Install markdownlint-cli2 (if not already installed)
brew bundle install

# Lint files using abbreviations
mdl                        # Lint *.md files in current directory
mdlf                       # Auto-fix *.md files in current directory
mdla                       # Lint **/*.md files recursively
mdlaf                      # Fix **/*.md files recursively

# Global validation with dotfiles config
mdv                        # Detailed validation (markdown-validate)
mdvf                       # Validation with auto-fix
mdvq                       # Quick fix with minimal output

CI Integration

Markdown validation is integrated into the main validation workflow. For manual validation:

# Validate markdown files
./scripts/validate-config.sh --validator markdown --fix

# Use the global wrapper from any directory
markdown-validate --fix

Customization

  • Dotfiles config: Edit ~/dotfiles/markdown/.markdownlint-cli2.yaml
  • Project-specific: Create markdown/.markdownlint-cli2.yaml or .markdownlint-cli2.yaml in project
  • Add abbreviations: Edit ~/dotfiles/shared/abbreviations.yaml and run reload-abbr
  • Global access: Use markdown-validate wrapper from any directory

About Neovim Distributions

[!TIP] TL;DR: Just install LazyVim💤

📺 Zero to IDE with LazyVim

Back in the day if you wanted to use Vim (and later Neovim) you had to code a ton of configuration on your own. With Vim we got Vimscript 🤢, but then came Neovim which brought us Lua 🤩. I went from ye olde crunchy .vimrc to the more adventurous init.vim to the blessed path of init.lua. 😇

Meanwhile, there were the VS Code boys across the fence, bragging about their fancy icons, shiny tabs, and the oh-so-cool LSP. I confess, I even tried VS Code for a bit. That didn't last long. 😬

But Neovim has caught up. And wow have they. caught. up. Not only do we have native LSP support in Neovim (have had for a while now — v0.5), but we are solidly in the era of pre-baked Neovim distributions that are really challenging the notion of Vim/Neovim as austere, command-line editors. (I will say that I think we owe a lot to VS Code for raising the bar here. But I'm still glad I'm with Neovim. 😉)

If you want a quick primer on Neovim distros, check out the YouTube video below. I started with LunarVim (my first entry into distro-land) and now I'm with LazyVim and the Folke gang. Bottom line: you can still config Neovim from scratch if you want to, but you can get a HUGE head-start by just grabbing a distro and tweaking it to your needs.

📺 I tried Neovim Distributions so you don't have to

Boy, when I reminisce about the days of writing PHP for Internet Explorer in BBEdit...

My Favorite Programming Fonts

Over the years, I’ve branched out to explore a variety of mono-spaced fonts, both free and premium. Here is a list of my favorites.

Free Fonts

Included in my Brewfile and installed by default via Homebrew Cask Fonts

Premium Fonts

You have to give people money if you want these. 🤑

Ligatures

I first discovered ligatures through Fira Code, which IMHO is probably the king of programming fonts. After using Fira Code, it’s hard to go back to a sans-ligature typeface. Therefore all the fonts I’ve included in my fave’s list do include ligatures, although some have more than others.

[!NOTE] Operator Mono does not include ligatures but can be easily patched to add them.

Nerd Fonts and Icons

Back in the day, I started using the VimDevicons plugin so I could have fancy file-type icons in Vim. (Remember NERDTree?) In order for this to work, one had to install patched “Nerd-font” versions of whatever programming font one wanted to use. For example:

# Original font
$ brew install --cask font-fira-code

# Patched variant
$ brew install --cask font-fira-code-nerd-font

Patching fonts with icons still works fine of course, and is, I think, pretty widely used. However, during my exploration of kitty, I discovered that there is a different (better?) approach to icon fonts. It turns out, you don't need a patched version of your chosen mono-spaced font. You can get most if not all the icons you need and use them alongside any font by just installing the Symbols Nerd Font Mono font.

Leveraging this approach depends on your terminal. In iTerm2, for example, you need to check “Use a different font for non-ASCII text” in the Preferences panel. Then select Symbols Nerd Font Mono font under “Non-ASCII font”. (see screenshot below)

iterm2-font-settings

kitty does things a little differently. If you install a patched font, it will mostly work. Mostly. But the “kitty way” can be broken down in three steps:

  1. Install a normal, un-patched mono-spaced font, such as Cascadia Code
  2. Install a dedicated icon font, such as Symbols Nerd Font Mono
  3. Create a set of Unicode symbol maps^2 to tell kitty which font to use for which icons (symbols)

More work up front, maybe, but less guesswork in the long-term once you understand what's going on. And if you're using my dotfiles, you have it easy. All the fonts you need are installed in Brewfile, and I have a set of Unicode symbol maps ready to go. 😎

[!NOTE] To learn more about Nerd fonts in terminals, as well as Unicode symbol maps and all the rest, be sure to check out Effective Nerd Fonts in Multiple Terminals by Elijah Manor

🧪 Nerd Font Smoke Test

If you want to check whether icons and ligatures are working properly, try running the included nerd-font-smoke-test.sh script from the root of the dotfiles folder like so:

bash nerd-font-smoke-test.sh

If your terminal is configured correctly, the output of the test should look like this:

smoke-test-output

Again, thank you, Elijah Manor!

Useful Font Links

A Note about Vim performance and Ruby files

Once upon a time, I almost left Vim due to some crippling performance issues. These issues were particularly painful when editing Ruby files. I documented what I learned here:

▹ What I’ve learned about slow performance in Vim

Identifying Sources of Slow Startup Times (Zsh)

The .zshrc script can be profiled by touching the file ~/.zshrc.profiler and starting a new login shell. To see the top 20 lines that are taking the most time use the zshrc_profiler_view. zshrc_profiler parameters are number of lines to show (20) and path to profiler log file ($TMPDIR/zshrc_profiler.${PID}log).

Awesome Neovim Dotfiles, Distros, and Starters

Some of my favorite dotfile repos

Helpful web resources on dotfiles, et al

License

Copyright © 2014–2025 Joshua Steele. MIT License