Trackenv logo
trackenv   removes uncertainty from deployments

Quickstart

From zero to ready in a few minutes.

Time to first diff: ~3 minutes

Prerequisite

Trackenv works by reading the version currently deployed in QA and PROD. The simplest setup is an HTTP endpoint returning"version" field.

Additional fields are fine, but "version" is required.
If your services expose versions in a different way and you still want to use Trackenv, contact us.

{
  "version": "7a88737d"
}

Quick setup

  1. 1

    Install Trackenv

    Download the binary for your platform and place it in your shell path.

    Linuxx86_64Windowsx86_64macOSIntelmacOSApple Silicon
  2. 2

    Create a read-only token

    GitHub needs read-only repository access. GitLab needs read_api.

    GitHubCreate a token with read-only repository access and export it in the GITHUB_ACCESS_TOKEN environment variable.export GITHUB_ACCESS_TOKEN=your_token_here
    GitLabCreate a token with read_api permission and export it in the GITLAB_ACCESS_TOKEN environment variable.export GITLAB_ACCESS_TOKEN=your_token_here
  3. 3

    Run discovery

    Paste the repository base URL and let Trackenv find candidate services.

  4. 4

    Save the generated YAML

    Trackenv writes the local config with services, endpoints, and repository metadata.

  5. 5

    That's it! You can now inspect your first diff

    See what is in QA but not yet in PROD, per service.

Generated YAML

The auto-discovery wizard creates this file for you at ~/.trackenv/trackenv.yaml.
This is the structure Trackenv reads.

services:
  - name: payments-service
    qa_url: https://qa.example.com/payments-service/version
    prod_url: https://prod.example.com/payments-service/version
    repository:
      type: github
      repository_url: https://api.github.com
      owner: your-org
      project_name: payments-service

  - name: billing-service
    qa_url: https://qa.example.com/billing-service/version
    prod_url: https://prod.example.com/billing-service/version
    repository:
      type: gitlab
      repository_url: https://gitlab.com
      project_id: 12345678

More features inside

Discover advanced in-app features: press H while inside Trackenv.