🚀 Cross-Platform Dotfiles

Documentation ( English, Japanese )

A powerful dotfiles management system designed for developers who work across multiple platforms. Seamlessly manages your development environment across Debian-based Linux (including WSL2), and macOS.

📚 Overview

Details

• ✨ Key Features
  • 🔄 Cross-Platform Compatibility
  • 🛡 Safe Configuration Management
  • 🎯 Smart Package Management
  • ⚡️ Enhanced Productivity Tools
  • 🎨 Terminal Customization
• 🚀 Quick Start
• 📦 What's Included
  • Core Tools
• 🔄 Backup and Restore
  • Automatic Backups
  • Restore Previous Configuration
• 🔎 FAQ
• 📝 License

✨ Key Features

🔄 Cross-Platform Compatibility

• WSL2: Full support for Windows Subsystem for Linux
• Debian-based Linux: Native support for Debian and Ubuntu
• MacOSX: Complete support for both Apple Silicon and Intel processors

🛡 Safe Configuration Management

• Automatic Backups: Every existing configuration is backed up before modification
• Easy Rollback: Restore your previous configuration with a single command:

  make restore

🎯 Smart Package Management

• Sheldon Integration: Modern plugin management using plugins.toml
  • Centralized plugin configuration
  • Fast, async plugin loading
  • Easy to maintain and update
• Platform-Specific Package Management:
  • Homebrew for MacOSX and Linux
  • apt for Debian-based systems

⚡️ Enhanced Productivity Tools

• FZF Integration:
  • Quick file search (Ctrl+T)
  • Command history search (Ctrl+R)
• Custom FZF Commands:
  • fb: Interactive Git branch switching
  • sf: Search file contents with preview
  • fd: Fast directory navigation based on file selection

🎨 Terminal Customization

• Nerd Fonts Support: Automatic installation and configuration
  • Windows (via Scoop)
  • MacOSX (via Homebrew)
• Terminal-Specific Setup:
  • Windows Terminal
  • iTerm2
  • Terminal.app

🚀 Quick Start

1. Clone the Repository:

   git clone https://github.com/yourusername/dotfiles.git
   cd dotfiles

2. Install:

   make install

3. Restart the shell

   exec zsh

📦 What's Included

Core Tools

• Shell: Modern ZSH configuration with Sheldon plugin management
• Git: Optimized Git configuration with useful aliases
• Terminal: Platform-specific terminal configurations
• Fonts: JetBrainsMono Nerd Font for a consistent look

🔄 Backup and Restore

Automatic Backups

• All existing configurations are automatically backed up before installation
• Backups are stored in ~/{fileName}.backup

Restore Previous Configuration

make restore

🔎 FAQ

1. Installing Nerd Fonts in Windows Terminal

   

   For WSL2 users, logs will be displayed as shown above. You can install Nerd Fonts by executing the displayed path in Windows Terminal.

2. Adding zsh plugins

   We use sheldon as the plugin manager. Edit .config/sheldon/plugins.toml to add new plugins. Documentation can be found here.

3. Adding custom utility functions

   It's recommended to add your custom functions as plugins in the .zsh/plugins directory with names like foo.zsh, keeping them separate from .zshrc.

📝 License

This software is released under the MIT License.
You are free to use it within the scope of the license, but you must include the following copyright notice and license text when using this software:

• LICENSE.md

Additionally, the table of contents in this document was generated using the following software:

• toc-generator

For details on the toc-generator license, please see Third Party Notices.md.