Guides and Tutorials

Practical flows for first-time teams using both the dashboard and CLI.

DashboardSyncingGit Host Integration

Tutorial: First Project Setup

  1. Sign in on the dashboard and ensure you belong to an organization.
  2. Install envx CLI globally from npm.
  3. Run CLI login to authenticate your local machine.
  4. Run init to choose organization, project, and default environment.
  5. Pull variables, edit locally, then push a new version with changelog.
npm i -g envxtool-cli
envx login
envx init
envx pull
envx push --changelog "Add STRIPE_WEBHOOK_SECRET"

Tutorial: Deploy to Git Provider

  1. Authorize your project with GitHub or GitLab.
  2. Register the repository origin URL.
  3. Deploy to action or environment target.
envx githost authorize github
envx githost add app-repo https://github.com/acme/app
envx githost deploy app-repo action -e production

For flags and target semantics, see Git Host Integration.