Installation¶
Universal Installer (Recommended)¶
The universal installer sets up an isolated environment with all vault backends included.
macOS / Linux¶
Or with options:
# Skip agent binary download
curl -sSL https://raw.githubusercontent.com/jainal09/envdrift/main/install.sh | sh -s -- --no-agent
# Install a specific version
curl -sSL https://raw.githubusercontent.com/jainal09/envdrift/main/install.sh | sh -s -- --version 1.2.3
# Uninstall
curl -sSL https://raw.githubusercontent.com/jainal09/envdrift/main/install.sh | sh -s -- --uninstall
Windows (PowerShell)¶
Or with options (use environment variables when piping):
# Skip agent binary download
$env:ENVDRIFT_NO_AGENT = "1"; irm https://raw.githubusercontent.com/jainal09/envdrift/main/install.ps1 | iex
# Install a specific version
$env:ENVDRIFT_VERSION = "1.2.3"; irm https://raw.githubusercontent.com/jainal09/envdrift/main/install.ps1 | iex
# Uninstall
$env:ENVDRIFT_UNINSTALL = "1"; irm https://raw.githubusercontent.com/jainal09/envdrift/main/install.ps1 | iex
If running the script directly (saved locally), you can use parameters instead:
What the Installer Does¶
- Detects your platform (OS and architecture)
- Finds Python 3.11+ on your system
- Creates an isolated virtual environment at
~/.envdrift/venv - Installs
envdrift[vault](all vault backends) - Creates a wrapper script at
~/.envdrift/bin/envdrift - Optionally downloads the envdrift-agent binary (with checksum verification)
Add ~/.envdrift/bin to your PATH to use envdrift from anywhere.
pip Install¶
Optional Dependencies¶
envdrift has optional features that require additional packages:
Vault Backends¶
# Azure Key Vault
pip install envdrift[azure]
# AWS Secrets Manager
pip install envdrift[aws]
# HashiCorp Vault
pip install envdrift[hashicorp]
# GCP Secret Manager
pip install envdrift[gcp]
# All vault backends
pip install envdrift[vault]
Pre-commit Integration¶
Everything¶
Verify Installation¶
Requirements¶
- Python 3.11 or higher
- pydantic >= 2.0
- pydantic-settings >= 2.0