Skip to content
repoverlay 0.17.1 is available.Release notes

Migrating to 1.0

repoverlay 1.0 removes the hidden command forms that earlier versions kept for compatibility. Use the supported commands below.

Removed syntaxUse instead
repoverlay create-local ...repoverlay create --output <path> ...
repoverlay listrepoverlay browse
repoverlay edit --add <name> <files...>repoverlay edit add <name> <files...>
repoverlay edit --remove <name> <files...>repoverlay edit remove <name> <files...>
repoverlay edit --interactive <name>repoverlay edit <name>
repoverlay cache clearrepoverlay cache remove --all

Use create with --output instead of create-local:

Terminal window
repoverlay create --output ./my-overlay

create --output writes overlay files to the output directory and applies the overlay automatically. Use --dry-run to preview these actions without changes. See Creating and sharing overlays for the full procedure.

Use edit add to add files and edit remove to remove them. Use edit alone to open the selection menu:

Terminal window
repoverlay edit add my-overlay .envrc
repoverlay edit remove my-overlay old-file.txt
repoverlay edit my-overlay

Run repoverlay edit <name> without add or remove to open the selection menu again.

Use browse for interactive overlay selection:

Terminal window
repoverlay browse
repoverlay browse owner/repo
repoverlay browse ./path/to/overlays

repoverlay 1.0 rejects these unsupported source URL schemes:

  • file://...
  • ftp://...
  • http://...
  • Other unsupported scheme://... URLs

Use one of the supported source forms instead:

If you usedUse instead
file:///home/me/overlays/home/me/overlays
file://./overlays./overlays
file://~/overlays~/overlays
http://github.com/owner/repohttps://github.com/owner/repo

Supported source forms are:

  • Local paths: ./path, /absolute/path, ~/path
  • Git URLs: https://..., ssh://..., git@host:owner/repo.git
  • GitHub shorthand and bare owner references, such as owner/repo or owner

Before 1.0, repoverlay kept some hidden command aliases for compatibility. Version 1.0 removes them.

Version 1.0 supports only the documented commands and source syntax listed above. Update your scripts to use these forms before you upgrade to 1.0.