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

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/saeedya/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.6.tar.gz (13.6 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.6-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: envcmp-0.1.6.tar.gz
  • Upload date:
  • Size: 13.6 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.6.tar.gz
Algorithm Hash digest
SHA256 b750cfdf47c5cac244c1a00770b1b43c512e2a0e1c9cb8d2cacf948c78f7c571
MD5 0cc84fb4875cea6b29c4d05c950c8552
BLAKE2b-256 4a8e36ed8dfabac7c371d802e8ba57aa83a4ae8c0649bc0e6603a171377d7dc5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: envcmp-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 11.7 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 f312917e37c65d78846b9efaa3155ca24377d1067efe219d3244b35f7b8a49c0
MD5 ecb22757f09a1035d26cb93b0dd20f1f
BLAKE2b-256 26efcdc81b36118ad0fde858a6734c430393ec2467ed4d34a694bcb7de0821b7

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