Envful is a CLI tool that verifies the presence of environment variables. It looks inside your .env file and the host system. You can use it to run any process while ensuring all the variables are set.
Never again waste time debugging your app because of a misconfigured environment.
Use the convenience install script that can run on all bash systems. Run the following command in your terminal (git bash for Windows).
```bash
curl https://raw.githubusercontent.com/arvindell/envful/main/install.sh -o install.sh && bash install.sh ```
This command can also be used to update your installation.
You can install Envful using NPM.
```bash
npm install envful
npm install -g envful ```
Install directly from crates.io using cargo.
bash
cargo install envful
Envful uses the .env.example file as a manifest for which variables are needed. If your project has a .env.example it already supports envful! 🚀
Check for variables and undeclared variables using check:
bash
envful check
You can also specify a command to run if check is successful using the '--' separator. It will immediately fail if a variable is missing, showing a helpful message.
bash
envful -- echo "I am envful!"
This becomes very useful to check the environment inside package.json scripts:
json
"scripts": {
"dev": "envful -- next",
"build": "envful -- next build"
}
```
USAGE:
envful [OPTIONS]
OPTIONS: -d, --dir
SUBCOMMANDS: check Check if env has all required variables and warns if missing help Print this message or the help of the given subcommand(s) ```
Inside your .env.example file, you can declare the variables that your application requires. You can use the triple hash market (###) to add a description to the variable. Add [optional] to a variable for warning instead of failing.
Example:
```bash
DATABASE_URL=
APP_SECRET=
GA_ID= ```
This project welcomes contributions of any kind, whether you want to add new features, improve the documentation or just want to give some feedback.
Envful is published under the MIT license. See the LICENSE file for more information.