Skip to main content

Sync CI/CD variables and secrets between platforms

Project description

envcmp

Python License Tests Coverage CI

A lightweight CLI tool to sync CI/CD variables and secrets between platforms.

The problem

Your variables live in multiple places:

  • Terraform Cloud workspace
  • GitLab CI variables
  • GitHub Actions secrets
  • .env files

They should always be in sync — but no tool does this automatically.

Solution

# see what's different
envcmp diff --from gitlab:my-project --to terraform:my-workspace

# output
KEY          SOURCE      TARGET      STATUS
──────────────────────────────────────────────
DB_HOST      localhost   localhost   in sync
DB_PORT      5432        5432        in sync
API_KEY      ••••••••    (not set)   source only
STRIPE_KEY   (not set)   ••••••••    target only
DB_PASS      ••••••••    ••••••••    differs

# push changes from source to target
envcmp push --from gitlab:my-project --to terraform:my-workspace

# dry run — see what would be pushed
envcmp push --from gitlab:my-project --to terraform:my-workspace --dry-run

Supported platforms

Platform Read Write Status
.env files available
GitLab CI Variables available
Terraform Cloud available
GitHub Actions beta — write requires repo admin

Installation

pip install envcmp

Configuration

Copy .env.example to .env and fill in your credentials:

cp .env.example .env
GITLAB_URL=https://gitlab.com
GITLAB_TOKEN=glpat-...
GITLAB_PROJECT_ID=12345678

GITHUB_TOKEN=ghp_...
GITHUB_ORGANIZATION=my-org
GITHUB_REPOSITORY=my-repo

TERRAFORM_TOKEN=...
TERRAFORM_ORGANIZATION=my-org
TERRAFORM_WORKSPACE=my-workspace

Usage

# diff between two providers
envcmp diff --from gitlab:my-project --to terraform:my-workspace

# diff between two .env files
envcmp diff --from env:.env.production --to env:.env.staging

# push changes
envcmp push --from gitlab:my-project --to terraform:my-workspace

# dry run
envcmp push --from env:.env --to env:.env.staging --dry-run

# pull changes from target to source
envcmp pull --from env:.env.local --to gitlab:my-project

# dry run
envcmp pull --from env:.env.local --to gitlab:my-project --dry-run

Development

git clone https://github.com/your-username/envcmp.git
cd envcmp
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
pytest

Security

  • Secret values are never printed in plain text
  • All output uses masked values (••••••••)
  • Dependencies scanned with pip-audit and bandit

Contributing

Contributions are welcome! Here's how to get started:

  1. Fork the repository
  2. Create a branch: git checkout -b feat/your-feature
  3. Make your changes
  4. Run tests: pytest tests/unit/ tests/security/
  5. Run pre-commit: pre-commit run --all-files
  6. Commit: git commit -m "feat: your feature"
  7. Push and open a Pull Request

See docs/contributing.md for more details.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

envcmp-0.1.5.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

envcmp-0.1.5-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

Details for the file envcmp-0.1.5.tar.gz.

File metadata

  • Download URL: envcmp-0.1.5.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for envcmp-0.1.5.tar.gz
Algorithm Hash digest
SHA256 4b0834ef93fc986325c7a4c13a06fa2c0fe5752ebad9709b367cdbaeb0387073
MD5 2b82ffd87538fe0c6ef6945439077d16
BLAKE2b-256 7690097a92daedc5306856dc6aa7adf79f0351414dd2fb44c4892fdb342a270c

See more details on using hashes here.

File details

Details for the file envcmp-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: envcmp-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 11.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for envcmp-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6d5c8dc9aa23a27d955d57c57bcde324a875b25b660f48ce9c2b3811c499161a
MD5 130702d0dda243c327623329742bf205
BLAKE2b-256 260d6abf14a24d0244b1478bc455d9dc419f64510fadfb0e6a32d3073fd5f73c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page