README.md

set-me-up 👷🏼

A comprehensive dotfiles and system configuration framework.

Documentation

For detailed information about how set-me-up works, see the documentation.

For information about the setup and update scripts, see scripts/SCRIPTS.md.

Contributing

See CONTRIBUTING.md for development setup and how to run lint checks locally.

Quick Setup

To clone all repositories and recreate the complete directory structure:

git clone https://github.com/dotbrains/set-me-up.git
cd set-me-up
chmod +x scripts/setup.sh
./scripts/setup.sh

Updating Repositories

To update all repositories to their latest versions:

cd set-me-up
./scripts/update.sh

The update script will automatically skip repositories with uncommitted changes.

See scripts/SCRIPTS.md for detailed documentation on both scripts.

Directory Structure

set-me-up/
├── blueprint/          # Blueprint configuration
├── docs/               # Documentation
├── installer/          # Installation scripts
├── tests/              # Docker-based provisioning test scenarios
├── utilities/          # Utility scripts
├── shared/
│   └── ai-config/      # Shared AI agent/skill definitions
├── modules/
│   ├── colorschemes/    # Color scheme configurations
│   ├── debian/         # Debian/Linux modules
│   ├── macos/          # macOS/Homebrew modules
│   ├── macports/       # MacPorts module
│   ├── preferences/    # Preferences module
│   ├── template-module/ # Template for new modules
│   ├── universal/      # Universal modules
│   └── xcode/          # Xcode module
└── home/
    ├── codex/          # Codex CLI configuration
    ├── claude/         # Claude Code configuration
    ├── pi/             # pi coding agent configuration
    └── .config/
        ├── alacritty/  # Alacritty terminal config
        ├── bash/       # Bash configuration
        ├── fish/       # Fish shell configuration
        ├── gh-dash/    # GitHub dashboard configuration
        ├── nushell/    # Nushell configuration
        ├── nvim/       # Neovim configuration
        ├── opencode/   # OpenCode configuration
        ├── television/ # Television (tv) configuration
        ├── tmux/       # Tmux configuration
        └── zsh/        # Zsh configuration

Repositories

Core

• set-me-up-blueprint
• set-me-up-docs
• set-me-up-installer
• utilities

Testing

• set-me-up-tests

Modules

• colorschemes
• debian-modules
• macos-modules
• macports-module
• preferences-module
• template-module
• set-me-up-universal-modules
• xcode-module

Shared

• shared-ai-config

Config

• alacritty
• bash
• claude
• codex
• fish
• gh-dash
• nushell
• nvim
• opencode
• pi
• television
• tmux
• zsh

License

Licensed under PolyForm Shield 1.0.0. See LICENSE for details.