CLI Setup

Install the CLI package, then run setup and discovery commands.

Install the CLI Package

npm i -g envxtool-cli
envx --version

Commands

envx init
envx configure
envx login
envx logout
envx help [command]

Usage Examples

npm i -g envxtool-cli
envx login
envx init
envx configure
envx help
envx help pull

Step-by-Step

  1. Install the published CLI package globally.
  2. Run login and complete browser authorization.
  3. Run init to select organization, project, and default environment.
  4. Use configure when project or env context changes.
  5. Use help for command-specific usage and option descriptions.

What envx init Asks You

envx init is interactive. The exact questions depend on your organization/project state.

  1. Organization: if you belong to multiple orgs, it asksSelect an organization:. If there is only one org, it auto-selects it.
  2. Project: it asks Select a project: with existing projects plus Create new project.
  3. New project name: if you choose create project, it asksWhat do you want to name your new project? (You can also change this later in the web app).
  4. Environment: if environments exist, it asksSelect an environment to pull:. If none exist, it skips this and still writes config.

After selection, envx writes envx-config.json and tries to pull the selected environment version into your local env file.

What envx configure Asks You

envx configure uses the same prompt flow asinit, but starts from your existingenvx-config.json and rewrites it with your new selections.

  • It requires envx-config.json to already exist.
  • It prints your current config first.
  • It re-asks organization, project, and environment selection.
  • If no environments are found for the selected project, it warns and sets an empty environment in config.