CleanClientOverlays
Strips overlay URI entries from every blueprint-managed client in the tenant. Without -overlayName: removes every Source matching 'overlay:*'. With -overlayName: removes only entries matching 'overlay:<name>' exactly. Destructive — typical use is before a sanitised DumpTenant export; the operator can re-apply with Apply-IdentityOverlay afterwards (idempotent, no-op if state matches).
Examples
Strip every overlay:* entry from the active tenant (prompts for confirmation):
octo-cli -c CleanClientOverlays
Strip only overlay:local-dev entries; gerald-laptop and other overlays survive:
octo-cli -c CleanClientOverlays -n "local-dev"
Skip the confirmation prompt — typical CI / dump-pipeline usage:
octo-cli -c CleanClientOverlays -y
Options
| Short | Long | Required | Description |
|---|---|---|---|
-n | --overlayName | no | Optional overlay name. Without it, every 'overlay:*' source is removed. With it, only 'overlay:<name>' is removed. Same regex constraint as ApplyClientOverlay ([A-Za-z0-9._-]+). |
-y | --yes | no | Skip confirmation prompt |
Notes
Idempotent — clients with nothing to remove skip the per-client UpdateAsync + cache invalidation.
base / api / family:* entries are always preserved; only overlay:* matches are removed.
Typical workflow before sharing a tenant dump: CleanClientOverlays -y → DumpTenant → Apply-IdentityOverlay (re-applies the canonical local-dev set from octo-tools/overlays/identity-local-dev.yaml).