My Personal Dotfiles

This is my personal fork and customization of the dotfiles-codespaces repo for use in development containers and GitHub Codespaces. It's based on the original work of @dcreager and adapted by @vladistan.

Oh-My-Zsh Configuration

This repository includes a pre-configured Oh-My-Zsh setup with:

• Theme: half-life
• Plugins: git, gitfast, z, aliases, aws, azure, brew, git-auto-fetch, ssh, and fzf (if available)
• Custom Configuration: Located in dotfiles/.zshrc.symlink
• Custom Scripts: Store custom ZSH scripts in dotfiles/zsh/ with the .symlink extension

The Oh-My-Zsh installation is copied from dotfiles/.oh-my-zsh to ~/.oh-my-zsh during the install process.

Why is this needed?

Dotfiles repositories enable developers to maintain consistent configurations across different machines they work on. These repositories contain configuration files for different tools, allowing

Dotfiles repositories are super handy for developers. They keep your setup consistent across different machines you are working on. These repos save a ton of time setting up new systems. Plus, you can keep track of changes with version control and easily share your setup with your coworkers and friends. Sharing your dotfiles allows for mutual learning, as others can discover your clever setups while you gain insights from the community's configurations.

Examples of configurable items:

• Shell settings (e.g., .zshrc)
• Editor settings (e.g., .vimrc)
• Git configurations (e.g., .gitconfig)
• Special tools (e.g., pv, fzf, etc.)
• Oh-my-zsh plugins and themes
• Timezones
• Shell aliases

Dotfiles are very useful for development containers and code spaces. These setups are different from your local system, thus they do not share the same configuration files. While containers and code spaces give you a consistent base, dotfiles let you add your personal touch to these shared environments. This is especially handy when you're working with code spaces from repositories you don't own.

How do dotfiles work in development containers and Codespaces?

1. You configure your VSCode or GitHub with the dotfiles repository to use. Look at the links below for details:

• Personalizing GitHub Codespaces for your account

• Personalizing VSCode Dev containers with dotfile repositories

2. Every time a new development container or codespace environment is created, the dotfiles repository is automatically cloned into the container. Then the repository install script is run inside the container to set up everything.

Should I use it?

This setup is useful if you have an existing dotfiles setup based on the dcreager dotfiles manager Such as one of the ones below:

• dcreager dotfiles-base
• vladistan dotfiles-public
• rouge8 dotfiles
• cpaulik dotfiles

For a new setups I recommend using more modern tool like chez-moi that has a DevContainer feature

Alternatively, for a simpler container-only setup, you can refer to the guide by Bea Stollnitz on Codespaces Terminal Setup.

Why do you need a container-specific dotfiles repository?

Why not use your original dotfile repo? Dotfiles repos based on dcreager's manager use multiple repositories: a generic manager and custom dotfiles. The manager script is usually a clone of dcreager's repo, while the dotfiles repo contains personalized configurations.

DevContainers and CodeSpaces, however, allow using only a single repository for both the installation script and dotfiles. Additionally, different tools and cloud environments clone the repo in various locations, almost never into the home directory, which doesn't work with dcreager's manager.

This container-specific dotfiles repo addresses both issues by combining the management script and the dotfiles into a single monorepo and being flexible with the location it's cloned into.

Installation

This repository automatically installs and configures:

• Dotfiles: Custom shell and git configurations
• Oh-My-Zsh: ZSH framework with plugins and themes
• Shell Configuration: Sets ZSH as the default shell

Automatic Installation (Codespaces/Dev Containers)

1. Configure your GitHub Codespaces or VSCode Dev Container settings to use this repository
2. When a new container is created, the install.sh script automatically runs and:
   • Backs up any existing .zshrc file to .zshrc.bak
   • Copies Oh-My-Zsh configuration from dotfiles/.oh-my-zsh to your home directory
   • Installs all .symlink files (see below)
   • Changes your default shell to ZSH

Manual Installation

To manually install in any environment, run:

./install.sh

Understanding .symlink Files

Files with the .symlink extension are automatically linked to your home directory by the install script. The .symlink suffix is removed when creating the symlink.

Location: All .symlink files are stored in the dotfiles/ directory and subdirectories.

Examples:

• dotfiles/.zshrc.symlink → ~/.zshrc
• dotfiles/.gitconfig.symlink → ~/.gitconfig
• dotfiles/zsh/aliases.zsh.symlink → ~/zsh/aliases.zsh

You can view all symlink files by running:

./manage/dotfiles.sh list

Customizing Your Fork

If you'd like to create your own dotfiles based on this repo:

1. Fork this repository
2. Modify files in the dotfiles/ folder according to your preferences
3. Edit .symlink files to customize configurations
4. Update dotfiles/.oh-my-zsh settings if needed
5. Configure your environment to use your fork

WARNING:

Dotfile repositories are public, so don't put any API keys, passwords, or personal info in them. Use proper secret storage methods to handle these things. This way, your sensitive info stays safe and isn't exposed to unauthorized access. Always follow best practices for managing secrets and credentials to keep your data and systems secure.