Local .env copy CLI

EnvCopy CLI is a powerful command-line tool that simplifies the process of copying environment files for different projects. With just a few commands, you can effortlessly manage and replicate environment configurations across your projects.

This is useful when it comes to working within git worktrees, and you need the same .env(s) across multiple worktrees. Also sometimes when you need to run commands like git reset --hard; and git clean -dfx, you can always get your .env file back easily.

Simple Project Demo

https://github.com/y3owk1n/cpenv/assets/62775956/a61b0944-1507-4291-a81f-2fd4d198a572

Monorepo Project Demo

https://github.com/y3owk1n/cpenv/assets/62775956/d36b733d-a222-46ff-befe-bac8b6fd73ea

Prerequisites

Before using EnvCopy CLI, ensure you have the following prerequisites:

Node.js: Make sure you have Node.js installed on your machine.
Running cpenv for the first time will prompt you to setup your env-files folder.

You can set it to any folder you like, but the default is ~/.env-files

Organize your projects within your chosen directory. Each project should have its own subdirectory.

  ~/.env-files
  ├── single-env-project
  │   ├── .env
  ├── multi-env-project
  │   ├── .env
  │   ├── apps
  │   │   ├── web
  │   │   │   ├── .env
  │   │   ├── api
  │   │   │   ├── .env
  └── other-projects...

Features

Automatic Project Setup: Automatically setup the env-files folder if it doesn't exist through simple prompts.
Interactive Project Selection: Easily choose the project for which you want to copy environment files using a user-friendly interactive prompt or specify it directly through command-line options.
Automatic Overwrite: Use the --auto-yes option to automatically overwrite existing files without prompting for confirmation.
Global Overwrite Option: Opt for a global overwrite to replace all existing files in the current project with a single confirmation.

Getting Started

Installation

Install cpenv globally:

npm install -g cpenv

or locally:

npm install --save-dev cpenv
yarn add --dev cpenv
pnpm add -D cpenv
bun add -d cpenv

Usage

If you install globally, go to your project directory and run the following command in your terminal:

cpenv

If you install locally within a project, you can run the following command in your terminal:

pnpm cpenv # whatever package manager you are using

This will launch the interactive mode, guiding you through project selection and file copying.

Options

-p, --project : Specify the project for which you want to copy environment files.
-y, --auto-yes: Automatically overwrite files without prompting for confirmation.

Examples

Interactive Mode

cpenv # pnpm cpenv if running locally

Specify Project

cpenv -p single-env-project # pnpm cpenv if running locally

Specify Project and Enable Auto-Overwrite

cpenv -p multi-env-project --auto-yes # pnpm cpenv if running locally

Troubleshooting

If you encounter any issues or errors, please refer to the ~~troubleshooting section in the wiki~~ (Not ready yet).

Contributions

Feel free to contribute by opening issues, suggesting enhancements, or submitting pull requests. We value your feedback and ideas to enhance the capabilities of cpenv further!