Workstation Setup

This repository contains my personal dotfiles managed with chezmoi.

Table of Contents

• Features
• Quick Start
  • Prerequisites
  • Installation
  • Manual Setup
• Configuration
• Local Customizations
• Updating
• Uninstalling
• Troubleshooting
• Contributing

Features

• Cross-platform support (macOS/Linux)
• Modular configuration
• Secure handling of sensitive data
• Automatic dependency installation
• Easy updates and maintenance

Quick Start

Prerequisites

• Git
• cURL
• Homebrew (macOS/Linux)
• Zsh (will be installed automatically if not present)

Installation

sh -c "$(curl -fsLS get.chezmoi.io)" -- -b $HOME/.local/bin init --apply mtxr/dotfiles

This will:

1. Install chezmoi if not already installed
2. Initialize the dotfiles repository
3. Apply the configuration to your system

Alternative (if you have chezmoi already installed):

chezmoi init --apply mtxr/dotfiles

Updating:

chezmoi update

Shell Changes

The installer will automatically:

1. Install Zsh if not already present
2. Set Zsh as your default shell
3. Apply Zsh configuration from the dotfiles

Note: The shell change will take effect in new terminal sessions. After installation, please open a new terminal to start using Zsh.

Manual Setup

1. Clone this repository:

   chezmoi init --apply mtxr/dotfiles

2. Follow the interactive prompts to configure your system

Configuration

Edit ~/.local/share/chezmoi/chezmoi.toml.tmpl to modify default settings. The configuration includes:

• User information (name, email)
• SSH key configuration
• Development tools to enable/disable
• Node.js options

Local Customizations

You can make machine-specific customizations in these files (they won't be tracked by git):

• ~/.gitconfig_local - Local Git configuration
• ~/.zshrc_local - Local Zsh configuration
• ~/.localrc - Local shell configuration (sourced by .zshrc)

Updating

To update your dotfiles:

chezmoi update

Or manually:

cd $(chezmoi source-path)
git pull
chezmoi apply

Uninstalling

To remove all dotfiles managed by chezmoi:

sh -c "$(curl -fsLS https://raw.githubusercontent.com/mtxr/dotfiles/main/uninstall)"

Use --dry-run to see what would be removed:

sh -c "$(curl -fsLS https://raw.githubusercontent.com/mtxr/dotfiles/main/uninstall)" -- --dry-run

Troubleshooting

Common Issues

1. Permission Denied

   chmod +x ~/.local/bin/chezmoi

2. Command Not Found Make sure ~/.local/bin is in your PATH:

   echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
   source ~/.zshrc

3. Chezmoi Not Found After Installation

   export PATH="$HOME/.local/bin:$PATH"

Contributing

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Open a pull request

Features

• Cross-platform support (macOS, Ubuntu, Alpine Linux, and more)
• Zsh with plugins (with automatic fallback to Bash on minimal systems)
• Git configuration with sensible defaults
• Homebrew packages (macOS/Linux)
• Custom scripts and utilities
• Development tools and language support
• POSIX-compliant installation and uninstallation scripts
• Automatic dependency management
• Dry-run mode for safe testing
• Color-coded output for better readability
• 1Password integration

License

MIT