v1.17.0

Settings

Every Envpilot setting, its type and default, generated from the extension manifest.

Settings

Configure under Settings → Extensions → Envpilot (Cmd+,), or in settings.json.

Generated from the manifest

This table is generated from contributes.configuration in the extension's package.json. The previous hand-maintained version listed two settings that did not exist and omitted seven that did — hence the generator.

SettingTypeDefaultWhat it does
envpilot.serverUrlstringThe URL of the Envpilot server (auto-configured at build time)
envpilot.autoSyncbooleantrueAutomatically sync variables when workspace opens
envpilot.syncIntervalnumber300Interval (in seconds) for checking permission changes
envpilot.targetFilestring".env.local"Default target file for synced variables
envpilot.environmentstring"development"Default environment for synced variables. Options: development, staging, production.
envpilot.preventCopyOnRevokebooleantrueDelete synced .env files when permissions are revoked
envpilot.defaultConflictResolutionstring"prompt"Default action when existing .env files are found. Options: prompt, overwrite, backup, merge, skip.
envpilot.convexUrlstringConvex deployment URL for real-time sync (auto-detected from server if empty)
envpilot.enableCodeLensbooleantrueShow CodeLens annotations above .env files with sync status and actions
envpilot.commitGuard.enabledbooleantrueEnable dual-layer .env commit protection (VS Code staging guard + pre-commit hook)
envpilot.commitGuard.autoInstallHookbooleantrueAutomatically install a pre-commit hook to block .env file commits
envpilot.clipboardGuard.scopestring"all-managed"Which Envpilot-managed .env files block clipboard copy/cut. Options: all-managed, readonly-roles, off.
envpilot.cloakValuesbooleantrueVisually mask variable values in Envpilot-managed .env files (the file content on disk is unchanged). Masking uses editor decorations, so values may still be visible in surfaces VS Code renders directly: the minimap (with editor.minimap.renderCharacters on), peek views, and diff editors.
envpilot.autocomplete.enablebooleantrueSuggest variable names from your linked Envpilot project when typing environment variable references (process.env., os.getenv, etc.)
envpilot.hover.enablebooleantrueShow a masked Envpilot hover on recognized environment variable references, with a role-checked option to reveal the value
envpilot.idlePauseMinutesnumber10Minutes the window must stay unfocused before real-time sync (Convex WebSocket subscriptions) is paused. Set to 0 to disable idle-pausing and keep real-time sync running regardless of focus.

Notes on a few of them#

  • envpilot.serverUrl / envpilot.convexUrl are configured at build time and should be left alone unless you are running against a non-production instance.
  • envpilot.cloakValues masks with editor decorations. See the caveat in Protection.
  • envpilot.idlePauseMinutes trades a little freshness for a lot of idle connection cost. 0 disables pausing.
  • Unsync-on-close customization is Pro-gated (vscode_unsync_customization); on Free the project default applies.

Limits#

  • Settings marked machine scope cannot be set per workspace — that is deliberate for anything that changes where credentials are sent.
  • A setting change takes effect on the next sync unless stated otherwise; use Envpilot: Refresh to apply immediately.