@cl3tus/planum

Sync .env files with your Planum vault.

Installation

npm i -g @cl3tus/planum
# or
pnpm add -g @cl3tus/planum
# or
yarn global add @cl3tus/planum

Requires Node.js 20+.

Quick start

planum login              # authenticate via the browser
planum init --project my-app
planum pull --env dev     # download .env from the vault
planum push --env dev     # upload .env to the vault

Commands

| Command | Description | |---|---| | planum login | Authenticate via the web browser. | | planum logout | Forget the stored token. | | planum init | Create a .planumrc in the current directory. | | planum pull | Download a .env from a project + environment. | | planum push | Upload a .env to a project + environment. |

Each command supports --help for full option listings.

Common flags

• --project <slug> — project slug (read from .planumrc if omitted).
• --env <name> — environment name (e.g. dev, staging, prod).
• --file <path> — input/output file path (default: .env).

Configuration

planum init writes a .planumrc file at the project root with the default project and environment so later commands can be run without flags.

Credentials are stored in your OS user config directory after planum login.

Releases

Releases are automated via semantic-release on push to main. To trigger a CLI release, commit messages must use the cli scope:

feat(cli): add new command
fix(cli): handle missing .planumrc

Without the (cli) scope, the commit will be ignored by the CLI release pipeline.

License

MIT © Clement Osternaud