Skip to content

Quick Start

Get up and running with repoverlay in under two minutes.

  1. Install repoverlay

    See Installation for all options. The quickest way:

    Terminal window
    # macOS/Linux
    brew install tylerbutler/tap/repoverlay
    # Or with cargo
    cargo binstall repoverlay
  2. Apply an overlay

    Navigate to a git repository and apply an overlay from a local directory:

    Terminal window
    cd ~/projects/my-repo
    repoverlay apply ~/my-overlays/ai-config

    Or apply directly from a GitHub repository:

    Terminal window
    repoverlay apply https://github.com/user/shared-configs
  3. Check status

    See what overlays are applied:

    Terminal window
    repoverlay status
  4. Remove when done

    Terminal window
    repoverlay remove ai-config