Quick Start & Installation

Welcome to the envx-cli-tmr documentation.envx is a lightweight, CLI-first utility designed to help development teams securely synchronize environment variables across local machines, team members, and projects.

Secure Encryption

Secrets are encrypted at rest using industry-standard AES-256-GCM.

Interactive CLI

Zero token copying. Choose projects or active invites via arrow keys directly in the CLI.

Phase 1 Scale

Support for up to 3 projects per user and 10 teammates per project during launch.

# Installation

envx-cli-tmr is distributed as a global node package. You can install it on your local machine using NPM, Yarn, or Bun:

Using NPM
npm install -g envx-cli-tmr
Using Yarn
yarn global add envx-cli-tmr
Using Bun
bun add -g envx-cli-tmr

# Verification

Verify that the CLI has been successfully registered in your system's environment path by checking its version:

$ envx --version
envx-cli-tmr v1.0.14

To print the comprehensive help utility and list all commands, run:

$ envx --help

# Quick Start (90-Second Setup)

Follow this workflow to set up your first synchronized variables project:

1

Authenticate

Run envx login to authenticate via GitHub OAuth.

2

Create a Project

Run envx create to instantiate a new remote project container.

3

Push Secrets

Create a local .env file, then run envx push and select your project from the interactive terminal dropdown list using arrow keys.