Migrating to 1.0
repoverlay 1.0 removes the hidden command forms that earlier versions kept for compatibility. Use the supported commands below.
CLI syntax changes
Section titled “CLI syntax changes”| Removed syntax | Use instead |
|---|---|
repoverlay create-local ... | repoverlay create --output <path> ... |
repoverlay list | repoverlay 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 clear | repoverlay cache remove --all |
Creating local overlays
Section titled “Creating local overlays”Use create with --output instead of create-local:
repoverlay create --output ./my-overlaycreate --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.
Editing applied overlays
Section titled “Editing applied overlays”Use edit add to add files and edit remove to remove them. Use edit alone to open the selection menu:
repoverlay edit add my-overlay .envrcrepoverlay edit remove my-overlay old-file.txtrepoverlay edit my-overlayRun repoverlay edit <name> without add or remove to open the selection
menu again.
Browsing overlays
Section titled “Browsing overlays”Use browse for interactive overlay selection:
repoverlay browserepoverlay browse owner/reporepoverlay browse ./path/to/overlaysSource URL syntax changes
Section titled “Source URL syntax changes”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 used | Use instead |
|---|---|
file:///home/me/overlays | /home/me/overlays |
file://./overlays | ./overlays |
file://~/overlays | ~/overlays |
http://github.com/owner/repo | https://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/repoorowner
Compatibility policy for 1.0
Section titled “Compatibility policy for 1.0”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.