Skip to content

cheshirecode/dotfiles

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

86 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Dotfiles

Personal configuration files for shell environments and AI-assisted development tools.

Overview

This repository contains:

  • Shell configurations: Bash, Zsh, and common shell utilities
  • Git configuration: Global git settings and helpers
  • Claude Code integration: Comprehensive development guidelines and MCP server configurations
  • Development tools: Prettier, Stylelint, and other code quality tools

Quick Start

For Shell Configurations

# Clone the repository
git clone https://github.com/cheshirecode/dotfiles.git ~/.dotfiles

# Source shell configurations
source ~/.dotfiles/.bashrc  # For Bash
source ~/.dotfiles/.zshrc   # For Zsh

For Claude Code

See SETUP-CLAUDE.md for complete setup instructions.

Quick links:

Claude Code Integration

This repository includes comprehensive documentation and configurations for using Claude Code effectively in your development workflow.

What's Included

Core Documentation

  • CLAUDE.md - Complete development guidelines covering:
    • Development philosophy and best practices
    • Code quality standards
    • Git workflow and commit conventions
    • Testing strategies
    • Deployment patterns
    • Quality checklists
    • WSL-specific considerations

MCP Server Configuration

  • claude-mcp.example.json - Example MCP server configuration
    • Core servers (sequential-thinking, filesystem)
    • Optional servers (github, web-search)
    • Experimental servers
    • WSL and Docker integration notes

Supporting Documentation (docs/)

  • docs/mcp-servers.md - Detailed MCP server documentation

    • Setup instructions for each server
    • Authentication and API key management
    • Troubleshooting guide
    • WSL-specific Docker setup
  • docs/workflows.md - Reusable development workflow patterns

    • Atomic commit workflow
    • Feature development workflow
    • Test-driven development
    • Debugging investigation
    • Safe refactoring patterns
    • WSL environment considerations
  • docs/tool-mapping.md - Cursor to Claude Code migration guide

    • Comprehensive tool mapping
    • Side-by-side examples
    • Best practices and anti-patterns
    • WSL path handling

Platform Support

These configurations work on:

  • βœ… Linux (native)
  • βœ… macOS
  • βœ… WSL (Windows Subsystem for Linux) - Extensively documented

WSL users: Special attention has been given to WSL-specific considerations including Docker Desktop integration, path handling, performance optimization, and troubleshooting.

For Cursor Users

If you're migrating from Cursor, see:

  1. docs/tool-mapping.md - Tool equivalents and migration guide
  2. SETUP-CLAUDE.md - "Migration from Cursor" section

The .cursor/ directory contains Cursor-specific configurations that are maintained separately.

Repository Structure

.
β”œβ”€β”€ CLAUDE.md                    # Main Claude Code development guide
β”œβ”€β”€ SETUP-CLAUDE.md              # Claude Code setup instructions
β”œβ”€β”€ claude-mcp.example.json      # MCP server configuration template
β”œβ”€β”€ claude-code-migration.plan.md # Implementation plan (reference)
β”œβ”€β”€ docs/                        # Supporting documentation
β”‚   β”œβ”€β”€ mcp-servers.md          # MCP server details
β”‚   β”œβ”€β”€ workflows.md            # Development workflows
β”‚   └── tool-mapping.md         # Cursorβ†’Claude Code mapping
β”œβ”€β”€ .cursor/                     # Cursor-specific configurations
β”‚   β”œβ”€β”€ mcp.json                # Cursor MCP config
β”‚   └── rules/                  # Cursor AI rules
β”œβ”€β”€ .bashrc                      # Bash configuration
β”œβ”€β”€ .zshrc                       # Zsh configuration
β”œβ”€β”€ .shell_common                # Shared shell configuration
β”œβ”€β”€ .bash_profile                # Bash profile
β”œβ”€β”€ .profile                     # POSIX shell profile
β”œβ”€β”€ .gitconfig                   # Git configuration
β”œβ”€β”€ .ssh-agent.sh                # SSH agent helper
β”œβ”€β”€ .prettierrc.js               # Prettier configuration
β”œβ”€β”€ .stylelintrc                 # Stylelint configuration
└── README.md                    # This file

Shell Configurations

Features

  • Shared configuration: Common functions and aliases in .shell_common
  • SSH agent management: Automatic SSH agent setup
  • Git integration: Enhanced git aliases and helpers
  • NVM support: Node Version Manager integration
  • Docker helpers: Cleanup and management aliases
  • WSL compatibility: Works seamlessly in WSL environments

Installation

# Clone to your home directory
git clone https://github.com/cheshirecode/dotfiles.git ~/.dotfiles
cd ~/.dotfiles && bin/install.sh

# bin/install.sh is the SUPPORTED install path: detects your OS, installs
# runtime deps, runs the agent-skill installer (with the rmtree-safety
# sentinel), wires hooks, runs bin/doctor.sh. Idempotent β€” re-run is safe.
#
# If you want manual symlinks instead, BACK UP FIRST. `ln -sf` will
# silently overwrite an existing real ~/.bashrc / ~/.zshrc / ~/.gitconfig
# and destroy your work. Pattern that won't bite:
#   for f in .bashrc .bash_profile .zshrc; do
#     [[ -e ~/$f && ! -L ~/$f ]] && mv ~/$f ~/$f.pre-dotfiles
#   done
#   ln -sf ~/.dotfiles/.bashrc ~/.bashrc
#   ln -sf ~/.dotfiles/.bash_profile ~/.bash_profile
#   ln -sf ~/.dotfiles/.zshrc ~/.zshrc

# Reload your shell
source ~/.bashrc  # or source ~/.zshrc

Git Configuration

Includes:

  • Useful aliases
  • Better diff and merge tools
  • Credential management
  • WSL-compatible settings
# Link git configuration (BACK UP your existing ~/.gitconfig first!)
[[ -e ~/.gitconfig && ! -L ~/.gitconfig ]] && mv ~/.gitconfig ~/.gitconfig.pre-dotfiles
ln -sf ~/.dotfiles/.gitconfig ~/.gitconfig

Environment-Specific Notes

WSL (Windows Subsystem for Linux)

Important considerations for WSL users:

  1. File System Performance

    • Keep projects in WSL filesystem (/home/...) for best performance
    • Avoid working in /mnt/c/... when possible (slower I/O)
  2. Docker Integration

    • Use Docker Desktop for Windows with WSL2 integration
    • See docs/mcp-servers.md for Docker setup
  3. Path Handling

    • WSL uses Linux paths: /home/user/project
    • Windows paths accessible via: /mnt/c/Users/...
    • Use wslpath for path conversion
  4. Git Configuration

    • Configure line endings: git config --global core.autocrlf input
    • Use WSL-native git (not Windows git.exe)
  5. Claude Code with WSL

    • Config location: ~/.config/claude/mcp.json (Linux path in WSL)
    • Docker MCP servers work with Docker Desktop integration
    • See SETUP-CLAUDE.md for detailed WSL setup

Contributing

Feel free to open issues or submit pull requests with improvements.

When contributing:

  • Follow existing code style
  • Test changes in your environment
  • Update documentation as needed
  • Use conventional commit messages

License

MIT License - See LICENSE file for details

Author

cheshirecode


Additional Resources

Claude Code

External Links


Last Updated: 2026-01-21

About

No description or website provided.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors