envo-cli

Backup and restore .env files across machines with recovery-phrase authentication.

Features

• 🔐 Secure Backup: Encrypt and backup all .env files in your project directory tree
• 🔑 Recovery Phrase Authentication: Use BIP39 recovery phrases to authenticate and restore backups
• 🚀 Easy Restoration: Restore all backed-up .env files to their original locations across different machines
• 📋 Project Management: List all your backed-up projects
• 🛠️ Development Mode: Built-in support for local development environments

Installation

Via npm

npm install -g envo-cli

Via bun

bun install -g envo-cli

Quick Start

1. Initialize

Set up Envo for the first time:

envo init

This will guide you through the setup process and create your recovery phrase. Keep this phrase safe - you'll need it to restore your backups.

2. Backup

Backup all .env files in your project directory tree:

envo backup

This will:

• Find all .env files in the current directory and subdirectories
• Encrypt them using your credentials
• Upload them to the Envo API
• Provide a project identifier for future restoration

3. Restore

Restore your backed-up .env files on another machine:

envo restore

This will:

• Authenticate using your recovery phrase
• Download your backed-up projects
• Restore the .env files to their original locations

4. List

See all your backed-up projects:

envo list

This will display a list of all projects you've backed up along with their metadata.

Commands

envo init

Initialize Envo for the current user.

Options:

• --dev - Use local API endpoint (http://localhost:4400)

envo init
envo init --dev

envo backup

Backup all .env files in the current directory tree.

Options:

• --dev - Use local API endpoint (http://localhost:4400)

envo backup
envo backup --dev

envo restore

Restore all .env files to their projects.

Options:

• --dev - Use local API endpoint (http://localhost:4400)
• --force - Overwrite existing .env files

envo restore
envo restore --force
envo restore --dev --force

envo list

List all backed-up projects.

Options:

• --dev - Use local API endpoint (http://localhost:4400)

envo list
envo list --dev

Security

• All .env files are encrypted using Argon2 before transmission
• Your recovery phrase is never stored or transmitted
• Authentication is performed using BIP39 recovery phrases
• Each backup is cryptographically secured

Development

Prerequisites

• Node.js >= 18.0.0
• Bun (for development and building)

Setup

git clone <repository>
cd apps/cli
bun install

Development Server

Run the CLI in development mode:

bun dev

Build

Build the project:

bun run build

Lint

Check code quality:

bun run lint

Test

Run tests:

bun test

Development Mode

For local development, use the --dev flag to point to your local API endpoint:

envo init --dev
envo backup --dev
envo restore --dev
envo list --dev

Environment Variables

The CLI respects the following environment variables:

• ENVO_API_URL - Override the API endpoint URL
• ENVO_DATA_DIR - Override the default data directory for storing credentials

Troubleshooting

I forgot my recovery phrase

Unfortunately, without your recovery phrase, you cannot restore backups. Always keep your recovery phrase in a secure location.

The backup failed

Make sure you:

1. Have initialized Envo (envo init)
2. Have an active internet connection
3. Have permission to read .env files in your directory
4. Are pointing to the correct API endpoint (use --dev if running locally)

Restore is not finding my files

Ensure:

1. You're using the correct recovery phrase
2. The backed-up projects were created with the same user credentials
3. Your internet connection is stable

Configuration Files

The CLI stores configuration in:

• Unix/Linux/macOS: ~/.envo/
• Windows: %APPDATA%\envo\

License

MIT

Support

For issues, questions, or suggestions, please visit the GitHub repository.