Setup Configuration

A modular configuration bank for building reproducible development environments across platforms.

This repository provides automated setup scripts and dotfiles for macOS, Ubuntu Server, and Windows, enabling consistent development environments with a single command.

Quick Start

Bootstrap your entire development environment with one command:

macOS

curl -fsSL https://raw.githubusercontent.com/ZiedYousfi/myconfig/main/bootstrap.sh | bash -s -- macos

Ubuntu Server

curl -fsSL https://raw.githubusercontent.com/ZiedYousfi/myconfig/main/bootstrap.sh | bash -s -- ubuntu

Windows

powershell -ExecutionPolicy Bypass -Command "irm https://raw.githubusercontent.com/ZiedYousfi/myconfig/main/bootstrap.ps1 | iex"

Interactive Mode (Auto-detect or Choose)

/!\ This does not work on Windows. Use the Windows command above instead.

curl -fsSL https://raw.githubusercontent.com/ZiedYousfi/myconfig/main/bootstrap.sh | bash

The bootstrap script will:

1. Download the latest release
2. Extract all configuration files
3. Run the appropriate platform installer
4. Set up dotfiles using GNU Stow (macOS/Ubuntu) or copy to Windows locations
5. Install all necessary tools and packages

What Gets Installed

Common (macOS & Ubuntu Server)

• Shell: Zsh with Oh My Zsh
• Terminal: Ghostty
• Editor: Neovim with full configuration
• Multiplexer: Tmux
• File Manager: Yazi
• Code Editor: Zed
• CLI Tools: fzf, ripgrep, bat, eza, fd, and more

macOS Specific

• Homebrew packages
• Window manager: Yabai
• Status bar: SketchyBar
• macOS system preferences

Ubuntu Server Specific

• Homebrew for Linux
• Server-optimized tooling
• Systemd service configurations

Windows Specific

• Winget packages
• Window manager: GlazeWM
• Status bar: Zebar (Monokai theme)
• WSL Ubuntu integration (if installed)

Manual Installation

If you prefer to inspect before running:

# Clone the repository
git clone https://github.com/ZiedYousfi/myconfig.git
cd myconfig

# Run the appropriate install script
./macos/install.sh          # For macOS
./ubuntu-server/install.sh  # For Ubuntu Server
./windows/install.ps1       # For Windows (PowerShell)

Dotfiles Structure

dotfiles/
├── ghostty/    # Terminal emulator config
├── nvim/       # Neovim configuration
├── tmux/       # Tmux configuration
├── yazi/       # File manager config
├── zed/        # Zed editor config
└── zsh/        # Zsh and Oh My Zsh config

Creating a Release

To create a new release and trigger the packaging workflow:

# Tag a new version
git tag -a v1.0.0 -m "Release v1.0.0"
git push origin v1.0.0

Or manually trigger via GitHub Actions:

1. Go to Actions tab
2. Select "Create Release" workflow
3. Click "Run workflow"
4. Enter a tag name (e.g., v1.0.0)

Features

• Idempotent: Safe to run multiple times without side effects
• Modular: Shared dotfiles with platform-specific additions
• Automated: Installs all dependencies and tools
• Documented: Full specifications in SPECS.md
• Backed Up: Automatically backs up existing configurations

Uninstalling

Each platform has an uninstall script:

./macos/uninstall.sh          # macOS
./ubuntu-server/uninstall.sh  # Ubuntu Server
./windows/uninstall.ps1       # Windows (PowerShell)

Documentation

See SPECS.md for complete configuration specifications and details about all installed components.

Requirements

Minimal requirements - the bootstrap script handles everything else:

macOS/Ubuntu:

• curl - for downloading
• unzip - for extracting archives
• Internet connection

Windows:

• PowerShell 7+ (pre-installed on Windows 10/11)
• Winget (pre-installed on Windows 10 1709+)
• Internet connection

License

MIT License - see LICENSE file for details

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.