https://github.com/maxiviper117/dotenvx-interactive-cli
https://github.com/maxiviper117/dotenvx-interactive-cli
cli dotenvx npm-package
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/maxiviper117/dotenvx-interactive-cli
- Owner: Maxiviper117
- License: mit
- Created: 2025-03-18T14:05:17.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-27T18:06:37.000Z (about 1 year ago)
- Last Synced: 2025-04-27T19:21:53.535Z (about 1 year ago)
- Topics: cli, dotenvx, npm-package
- Language: TypeScript
- Homepage:
- Size: 128 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# dotenvx-interactive-cli
An interactive CLI tool for managing your .env files with dotenvx. This tool provides a user-friendly interface for encrypting and decrypting environment files, as well as setting up precommit hooks.
## Why?
This tool was created to simplify the process of working with dotenvx encryption and decryption. Instead of typing long commands or remembering specific syntax, you can quickly:
- Select which .env files to encrypt or decrypt through an interactive menu
- Avoid typing lengthy dotenvx commands manually
- Selectively encrypt or decrypt specific files when working with multiple .env files
- Set up precommit hooks with a single command
## Prerequisites
- [Node.js](https://nodejs.org/) (v16 or higher)
- [dotenvx](https://github.com/dotenvx/dotenvx) must be installed globally (`npm install -g @dotenvx/dotenvx`)
## Installation
You can install this package globally:
```bash
npm install -g dotenvx-interactive-cli
```
Or use it directly with npx:
```bash
npx dotenvx-interactive-cli
```
## Features
- 🔒 Interactive encryption of .env files
- 🔓 Interactive decryption of .env files
- 🪝 Easy precommit hook installation
- ✨ User-friendly selection interface for multiple .env files
- 🔍 Automatic .env file detection
- ⚡ Validation of dotenvx installation and required files
## Usage
1. Navigate to your project directory where your .env files are located
2. Run the CLI tool:
When installed globally:
```bash
dotenvx-interactive
```
or use npx:
```bash
npx dotenvx-interactive-cli
```
1. Choose from the available options:
- Encrypt .env files
- Decrypt .env files
- Install precommit hook
- Exit
### Requirements
- A `.env.keys` file must be present in your project directory
- dotenvx must be installed globally
## License
MIT
## Contributing
Contributions, issues, and feature requests are welcome!