Skip to content
arnodirlamPublic

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

dev-setup

A comprehensive development environment setup repository with reusable configuration files (dotfiles) and automated setup scripts. Files in dotfiles/ are designed to be symlinked to your home directory for easy management and version control.

Quick Start

Bootstrap Everything

Set up your entire development environment in one command:

# Dry-run (preview what will happen)
just bootstrap

# Actually perform the setup
just bootstrap doit=true

This will:

  1. Link all dotfiles from dotfiles/ to ~/ recursively
  2. Install/update Homebrew packages from Brewfile
  3. Prompt you to choose and configure a default shell (zsh or fish)

Manual Setup

If you prefer more control, you can set up components individually:

# Link all dotfiles
just link-all doit=true

# Apply Brewfile
just brew-apply doit=true

# Setup and configure zsh with Oh My Zsh
just setup-zsh doit=true
just set-default-shell zsh doit=true

# Or setup fish shell
just setup-fish doit=true
just set-default-shell fish doit=true

Available Commands

Dotfiles Management

The dotfiles/ directory contains configuration files that should live in your home directory. Instead of copying them, this repository creates symlinks:

# Link all dotfiles
just link-all doit=true

# Link a specific file
just link .zshrc doit=true
just link .config/fish/config.fish doit=true

# Import an existing file from your home directory
just import .vimrc doit=true

All these commands back up existing destinations before replacing them (when not in dry-run). Linking uses .backup, then .backup.1, .backup.2, etc., without replacing earlier backups. An already-correct symlink needs no backup and is left unchanged.

Add an empty .link-directory marker inside any directory that should be linked as a whole. Both just link and just link-all link that directory and skip its contents; unmarked directories keep file-by-file linking. For example:

dotfiles/.agents/skills/elixir-development/
  .link-directory
  SKILL.md
  references/
just link .agents/skills/elixir-development true

This creates one directory symlink, keeping SKILL.md a regular file for Codex discovery. Linking a child path also resolves to the outermost marked directory. Existing destination directories are preserved in a backup during migration.

Directory structure:

dotfiles/
├── .config/
│   ├── fish/
│   │   └── config.fish
│   └── mise/
│       └── config.toml
├── .zshrc
├── .zshenv
└── .zprofile

When linked, these files appear in ~/ as symlinks pointing back to this repository.

Homebrew Package Management

Sync installed Homebrew packages, casks, and taps from/to the Brewfile in this repo:

# Apply Brewfile, installing/uninstalling packages as needed
just brew-apply [doit=true]

# Install only new packages from Brewfile (no updates)
just brew-install [doit=true]

# Remove packages not listed in Brewfile
just brew-purge [doit=true]

# Generate Brewfile from currently installed packages
just brew-dump [doit=true]

Shell Configuration

Choose between zsh (with Oh My Zsh) or fish shell:

Zsh with Oh My Zsh:

just setup-zsh doit=true
just set-default-shell zsh doit=true

Fish shell:

just setup-fish doit=true
just set-default-shell fish doit=true

Oh My Zsh plugins are managed via the omz_plugins file int his repo:

# Install plugins listed in omz_plugins file
just omz-plugins-install doit=true

# Update plugins
just zsh-plugins-update

# Export currently installed plugins to omz_plugins file
just omz-plugins-dump doit=true

Utilities

# List Elixir dependency package names from projects in ~/dev
just list-elixir-packages [verbose=true]

# Run all tests
just check

# Run test suite
just test

How It Works

Dry-Run Mode

All commands that modify files use dry-run mode by default for safety. Commands will show what they would do without actually doing it.

# Preview changes (dry-run)
just link-all

# Actually perform the operation
just link-all doit=true

You'll see output like:

[DRY RUN] 🔗 Creating symlink: ~/.zshrc -> ~/dev/dev-setup/dotfiles/.zshrc

💡 This was a dry run. No files were actually modified.
   Run with doit=true to perform the actual operation.

Requirements

  • macOS (tested on darwin 24.6.0)
  • just - Command runner (install via brew install just)
  • Homebrew - Package manager for macOS

Tips

  1. Use tab completion: Run just without arguments to see all available commands
  2. Always dry-run first: Preview changes before applying them
  3. Keep Brewfile updated: Run just brew-dump doit=true after installing new packages
  4. Version control your changes: This repository is meant to be kept in git
  5. Customize dotfiles: Edit files in dotfiles/ and changes appear in ~/ immediately (via symlinks)

License

See LICENSE file.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages