@clever.gy/gcloud-env-secrets

CLI tool to retrieve secrets from Google Cloud Secret Manager and generate .env files based on templates.

📋 Description

@clever.gy/gcloud-env-secrets is a command-line tool that generates environment files (.env) by replacing placeholders in a template with actual values retrieved from Google Cloud Secret Manager.

✨ Features

• 🔐 Retrieves secrets from Google Cloud Secret Manager
• 📝 Generates .env files from templates with placeholders
• ✅ Validates gcloud configuration before execution
• 🛡️ Prompts for confirmation before overwriting existing files

📦 Installation

npm install -g @clever.gy/gcloud-env-secrets

Or install locally in a project:

npm install --save-dev @clever.gy/gcloud-env-secrets

🔧 Prerequisites

1. Google Cloud SDK (gcloud) installed and configured

   • Installation guide: https://cloud.google.com/sdk/docs/install
   • macOS (Homebrew): brew install --cask google-cloud-sdk

2. Authentication with Google Cloud

   gcloud auth application-default login
   

3. GCP project configured

   gcloud config set project YOUR_GCP_PROJECT
   

4. Required permissions: Your account must have permissions to access Secret Manager in the specified project.

🚀 Usage

gcloud-env-secrets <gcpProjectName> <envFileTemplatePath> <envFileOutputPath>

Example:

gcloud-env-secrets my-gcp-project .env.template .env

Parameters

• gcpProjectName: Google Cloud Platform project name
• envFileTemplatePath: Path to the .env template file with placeholders
• envFileOutputPath: Path where the final .env file will be generated

📝 Template format

Create a template file with placeholders using the format $$SECRET{secret-name}:

DATABASE_URL=$$SECRET{database-url}
API_KEY=$$SECRET{api-key}
JWT_SECRET=$$SECRET{jwt-secret}

The tool will find all placeholders and replace them with actual values from Secret Manager.

🛠️ Development

npm run lint     # Lint the code
npm start        # Run in development mode
npm run build    # Build the project

🔐 Security

• ⚠️ Never commit generated .env files to your repository
• ✅ Use .gitignore to exclude .env files
• ✅ Keep templates (.env.template) in the repository without sensitive values