Have ideas to improve npm?Join in the discussion! »

    configure-env
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0 • Public • Published

    configure-env

    CLI tool to generate and populate .env files from .env.example templates.

    npm (scoped) npm GitHubCode of Conduct PRs Welcome


    All Contributors

    About

    configure-env will read a .env.example or any other similar .env file and prompt for values for each variable that has a comment header above it. Afterwards it will generate a .env file out of it.

    It works as a more user-friendly approach to:

    cp .env.example .env
    

    Installation

    You can install the CLI tool via npm or another package manager. Ideally install it as a dev dependency instead of global:

    # Install it as a dev dependency 
    npm install configure-env --save-dev
     
    # Afterwards you can use by using: 
    node_modules/.bin/configure-env
     
    npx configure-env
     
    # Or inside your package.json scripts section as "configure-env" 

    Usage

    In a project that contains a .env.example file, run:

    $ npx configure-env --help
    Prompts user for environment variables and generates .env files based on a
    .env.example file
     
    Usage:
      configure-env.js -o [outputFile] -i [exampleFile]
     
    Options:
      --help        Show help                                              [boolean]
      --version     Show version number                                    [boolean]
      --output, -o  Location of the .env file that should be written
                                                          [string] [default: ".env"]
      --input, -i   Location of input .env.example file for prompts
                                                  [string] [default: ".env.example"]
      --verbose                                           [boolean] [default: false]
     
    Examples:
      npx configure-env       Reads a .env.example file in the current directory and
                              creates a .env file
      configure-env.js | cat  The output can be either written to a file or piped to
                              another process
     
    This project is part of Twilio Labs. Please file any issues
    github.com/twilio-labs/configure-env
     

    Contributing

    This project welcomes contributions from the community. Please see the CONTRIBUTING.md file for more details.

    Code of Conduct

    Please be aware that this project has a Code of Conduct. The tldr; is to just be excellent to each other ❤️

    Contributors

    Thanks goes to these wonderful people (emoji key):

    Dominik Kundel
    Dominik Kundel

    💻

    This project follows the all-contributors specification. Contributions of any kind welcome!

    License

    MIT

    Install

    npm i configure-env

    DownloadsWeekly Downloads

    287

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    16 kB

    Total Files

    15

    Last publish

    Collaborators

    • avatar