Skip to content
repoverlay

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. Check that nothing is applied yet

    Navigate to a git repository and check the current status:

    Terminal window
    cd ~/projects/my-repo
    repoverlay status

    You should see: No overlays applied.

  3. Apply an overlay

    Apply an overlay from a shared source — this will show you available overlays and let you pick:

    Terminal window
    repoverlay apply tylerbutler

    Select an overlay from the interactive list. repoverlay will ask if you want to save the source for future use.

  4. Check status again

    Terminal window
    repoverlay status

    You'll see the applied overlay, its source, and the files it manages.

  5. Remove when done

    Terminal window
    repoverlay remove my-overlay

Next steps

Section titled “Next steps”