Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@dotenvx/dotenvx-pro

dotenvx2.2k0.26.0

Secrets Manager for Env Files

dotenvx, dotenv, env, secrets manager, secrets, manager

readme

dotenvx pro

Dotenvx Pro is a commercial extension for dotenvx.

Secrets Manager for Env Files 🏆

  • Encrypted
  • Cloaked
  • Secrets as Code

Learn more

 

Quickstart npm version downloads

Install dotenvx pro.

<summary>with npm 📦</summary>
npm install @dotenvx/dotenvx-pro --save
npx dotenvx pro help
<summary>with curl 🌐 </summary>
curl -sfS https://dotenvx.sh/pro | sh
dotenvx pro help
<summary>with brew 🍺</summary>
brew install dotenvx/brew/dotenvx-pro
dotenvx pro help
<summary>or with github releases 🐙</summary>
curl -L -o dotenvx-pro.tar.gz "https://github.com/dotenvx/dotenvx-pro/releases/latest/download/dotenvx-pro-$(uname -s)-$(uname -m).tar.gz"
tar -xzf dotenvx-pro.tar.gz
./dotenvx-pro help

 

Then encrypt and cloak.

$ dotenvx encrypt
$ dotenvx pro cloak
✔ cloaked (DOTENV_PRIVATE_KEY)

That's it, enjoy Pro! 🏆

Usage

$ dotenvx pro
Usage: @dotenvx/dotenvx-pro [options] [command]

dotenvx pro 🏆

Options:
  -l, --log-level <level>   set log level (default: "info")
  -q, --quiet               sets log level to error
  -v, --verbose             sets log level to verbose
  -d, --debug               sets log level to debug
  -V, --version             output the version number
  -h, --help                display help for command

Commands:
  sync [options]            sync
  push [options]            push
  pull [options]            pull
  open [options]            view repository on dotenvx pro
  login [options]           log in
  logout [options]          log out
  keypair [options] [key]   print public/private keys for .env file(s)
  ls [options] [directory]  print all .env files in a tree structure
  settings                  ⚙️  settings

Advanced

Become a dotenvx pro power user.

CLI 📟

Advanced CLI commands.

  • <summary>`pro keypair`</summary>

    Print fully managed public/private keys for .env file.

    $ echo "HELLO=World" > .env
    $ dotenvx encrypt
    
    $ dotenvx pro push
    
    $ dotenvx pro keypair
    {"DOTENV_PUBLIC_KEY":"<publicKey>","DOTENV_PRIVATE_KEY":"<privateKey>"}
  • <summary>`pro keypair -f`</summary>

    Print fully managed public/private keys for .env.production file.

    $ echo "HELLO=Production" > .env.production
    $ dotenvx encrypt -f .env.production
    
    $ dotenvx pro push
    
    $ dotenvx pro keypair -f .env.production
    {"DOTENV_PUBLIC_KEY_PRODUCTION":"<publicKey>","DOTENV_PRIVATE_KEY_PRODUCTION":"<privateKey>"}
  • <summary>`pro keypair DOTENV_PRIVATE_KEY`</summary>

    Print specific fully managed keypair for .env file.

    $ echo "HELLO=World" > .env
    $ dotenvx encrypt
    
    $ dotenvx pro push
    
    $ dotenvx pro keypair DOTENV_PRIVATE_KEY
    <privateKey>
  • <summary>`pro settings org`</summary>

    Print organization.

    $ dotenvx pro settings org
    motdotla
  • <summary>`pro settings orgpublickey`</summary>

    Print organization public key–used for encrypting project private keys.

    $ dotenvx pro settings orgpublickey
    02761eccd2a442ebbfa14ac2e72762d885a1e96b8949428deea62db305947d6408
  • <summary>`pro settings orgprivatekey`</summary>

    Print masked organization private key–used for decrypting project private keys.

    $ dotenvx pro settings orgprivatekey
    322c004*********************************************************
  • <summary>`pro settings orgprivatekey --unmask`</summary>

    Print unmasked organization private key–used for decrypting project private keys.

    $ dotenvx pro settings orgprivatekey --unmask
    322c004271ac6ad1b548df3f316ff4e8f08e17e0b15f459db64f3f3b48b0efb7
  • <summary>`pro settings orgteam`</summary>

    Print team status in tabular format.

    $ dotenvx pro settings orgteam
    ╔═══════════╤════════╗
    ║ username  │ synced ║
    ╟───────────┼────────╢
    ║ motdotla  │ ✔      ║
    ╟───────────┼────────╢
    ║ motdotenv │ ✔      ║
    ╚═══════════╧════════╝
  • <summary>`pro settings storetree`</summary>

    Print encrypted store tree–backing your dotenvx pro installation.

    $ dotenvx pro settings storetree
    ├─ .env
    └─ pro.dotenvx.com
       ├─ user-1-organization-1.json
       ├─ user-1-private-key.json
       └─ user-1.json

changelog

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

Unreleased

0.26.0

  • Logger says dotenvx-pro and uses pro version (#44)

0.25.0

  • Proxy config to dotenvx.config (#43)

0.24.0

  • Update recover command to store user private key in asymmetric at rest device-level encryption (#38)

0.23.0

  • Improve device mechanisms

0.22.0

  • Sync devices and associated public keys and encrypted private keys

0.21.0

Changed

  • Improved device encrypted private keys (#36)

0.20.0

Added

  • Identify device as part of sync handshake (#35)

0.19.0

Added

  • Generate a device identifier to be used with holding user private key encrypted at rest (#34)

0.18.3

Changed

  • Patch cloak

0.18.2

Changed

  • Patch cloak

0.18.1

Changed

  • Patches to cloak command

0.18.0

Added

  • Add cloak command

0.17.5

Changed

  • Attempt with v version to please homebrew

0.17.4

Changed

  • Extract version for use with homebrew formulua

0.17.3

Added

  • add version to homebrew formulua (#32)

0.17.2

Changed

  • use full paths for settings storetree (#31)

Unreleased

0.17.1

Changed

  • 🐞 fix --unmask regression (#30)

0.17.0

Added

  • add pro settings storetree to display encrypted store file structure (#29)

0.16.0

Changed

  • switch to using depends_on for homebrew (#28)

0.15.1

Changed

  • fix the install script

0.15.0

Added

  • install dotenvx if not already installed (#27)

0.14.1

Changed

  • bump undici

0.14.0

Added

  • installing dotenvx pro should also install dotenvx

0.13.0

Added

  • add open command (#25)

0.12.2

Changed

  • respect process.env ahead of synced db data (#23)

0.12.1

Added

  • add lib/main.js so require loads without error (#21)

0.12.0

Added

  • add dotenvx pro keypair --format shell option (#20)

0.11.0

Added

  • add dotenvx pro keypair command (#19)

Removed

  • remove dotenvx pro privatekey command. (keypair services this need more flexibly) (#19)

0.10.2

Changed

  • patch db/organization.js (#18)

0.10.1

Added

  • add settings hostname command

0.10.0

Added

  • add sync, push, privatekey commands (#17)

0.9.0

Added

  • add ls command with checkmarks (#15)

0.8.0

Added

  • introduce dotenvx organizations for managing organizations (#14)

0.7.3

Removed

  • removed dotenvx settings systeminformation (#13)

0.7.2

Changed

  • switch to pdf-lib under the hood for the emergency kit (#12)

0.7.1

Changed

  • patch emergencykit.js to emergencyKit.js (#11)

0.7.0

Added

  • add settings privatekey to print privateKey
  • add settings emergencykit to print emergency kit (#10)

0.6.0

  • move fingerprinting to the service for better security/obfuscation

0.5.0

Added

  • send machine fingerprint with device code request (#9)

0.4.1

Changed

  • patch store

0.4.0

Added

  • add settings recover (recovers your account) (#5)

0.3.0

Added

  • produce machine fingerprint (#3)

0.2.0

Added

  • add login support with public/private key generation (#2)
  • add settings recoveryphrase (#2)
  • add settings publickey (#2)

0.1.3 and prior

Please see commit history.