envx cli v2.0.1

this CLI is in alpha and is not guaranteed to work

Author: @alexng353

A very simple cli written for envx-project/api

Migration from v1 to v2

• envx config folder has been moved from ~/.config/envx to ~/.config/envx/config.json

Please run envx config migrate to migrate your config file to the new format.

Installation

# MacOS, Linux
curl -fsSL get.envx.sh | bash

# Windows (PowerShell, no administrator rights needed)
powershell -c "irm https://raw.githubusercontent.com/envx-project/cli/main/install.ps1 | iex"

For more detailed instructions, see windows installation

setting a primary key password command

You can set a primary key password command (such as op read "op://my secret password") by setting config.primary_key_command in your config file.

{
    ...
    "primary_key_command": ["op", "read", "op://my secret password"]
}

A command will be available for this in the future (maybe). See #72.

Readable output and local nicknames

Set a local nickname with envx friends --rename <user-id> --alias <nickname>. The nickname appears alongside the account name in friend lists, inbox entries, send confirmations, project member lists, and removal menus. Nicknames stay local to the current account and server; they do not change user IDs or fingerprint trust.

Normal output shows short identity references and concise success summaries. Use --verbose with friends, add-friend, friend-link, set, auth, project list-users, project info, project remove-user, or get project for full IDs or diagnostic details. Short IDs are display references, not accepted as user-ID arguments. project list-users --all explicitly includes public keys. Existing --json output remains unchanged for scripts.

Usage

Interact with envx servers via CLI

Usage: envx [OPTIONS] <COMMAND>

Commands:
  auth       Test authentication with the server
  export     Export a public or secret key
  gen        Generate a key using GPG Saves the key to ~/.config/envx/keys/<fingerprint>
  import     Import ascii armored keys from a file
  link       Link a project to the current directory
  list-keys  List all keys in the config
  run        Run a local command using variables from the active environment
  set        Set a variable (Interactive)
  shell      Open a subshell with envx variables available
  unlink     Unlink the current project
  unset      Unset (delete) an environment variable
  update     Self-update envx using the installation script
  upload     If your key is not in the database, use this command to upload it
  variables  Get all environment variables for the current configured directory
  version    Fancy, pretty-printed version information
  whoami     Print the primary key fingerprint and uuid
  config     Configure envx
  delete     Delete a resource. (project, key)
  get        Get a resource. (project, key, config)
  keyring    Interact with the envx keyring. All commands are interactive
  project    Command group for project related commands
  help       Print this message or the help of the given subcommand(s)

Options:
      --silent
  -h, --help     Print help
  -V, --version  Print version

Attributions

This project is licensed under the GPLv3 License. A copy of the GPLv3 License can be found in the LICENSE file.

This project uses code from the Railway's CLIv3, copyright (c) [2023] Railway Corp. The Railway CLI is licensed under the MIT License. A copy of the MIT License can be found in the attributions/railway/LICENSE file.

Log in on another machine

Run envx auth link on your existing machine and keep its terminal open. Run the printed envx auth login '<link>' command on the new machine, enter its verification code on the original machine, then enter your existing identity passphrase on the new machine. Links contain only a pairing identifier; identity material travels through an encrypted, verified channel. See pairing and its security contract.

Identity commands are also available under auth: status, gen, register, and export. Existing command spellings remain supported.