Gathering detailed insights and metrics for env-cmd
Installations
npm install env-cmdDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Min. Node Version
>=8.0.0
Node Version
12.14.1
NPM Version
6.13.4
Score
98.1
Supply Chain
100
Quality
75.8
Maintenance
100
Vulnerability
100
License
Releases
Unable to fetch releases
Contributors
22
Unable to fetch Contributors
Languages
2
TypeScript
JavaScript
TypeScript (96.97%)
JavaScript (3.03%)
Love this project? Help keep it running — sponsor us today! 🚀
Developer
Download Statistics
Total Downloads
171,836,999
Last Day
224,062
Last Week
1,153,930
Last Month
4,900,140
Last Year
51,523,883
GitHub Statistics
MIT License
1,770 Stars
194 Commits
68 Forks
14 Watchers
5 Branches
22 Contributors
Updated on Feb 14, 2025
Bundle Size
32.10 kB
Minified
10.63 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
10.1.0
Package Id
env-cmd@10.1.0
Size
13.75 kB
NPM Version
6.13.4
Node Version
12.14.1
Published on
Feb 10, 2020
Total Downloads
Cumulative downloads
Total Downloads
171,836,999
Last Day
3.8%
224,062
Compared to previous day
Last Week
3%
1,153,930
Compared to previous week
Last Month
35.5%
4,900,140
Compared to previous month
Last Year
13.3%
51,523,883
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
env-cmd
A simple node program for executing commands using an environment from an env file.
???? Install
npm install env-cmd or npm install -g env-cmd
⌨️ Basic Usage
Environment file ./.env
1# This is a comment 2ENV1=THANKS 3ENV2=FOR ALL 4ENV3=THE FISH
Package.json
1{ 2 "scripts": { 3 "test": "env-cmd mocha -R spec" 4 } 5}
Terminal
1./node_modules/.bin/env-cmd node index.js
Using custom env file path
To use a custom env filename or path, pass the -f flag. This is a major breaking change from prior versions < 9.0.0
Terminal
1./node_modules/.bin/env-cmd -f ./custom/path/.env node index.js
???? Help
1Usage: _ [options] <command> [...args] 2 3Options: 4 -v, --version output the version number 5 -e, --environments [env1,env2,...] The rc file environment(s) to use 6 -f, --file [path] Custom env file path (default path: ./.env) 7 --fallback Fallback to default env file path, if custom env file path not found 8 --no-override Do not override existing environment variables 9 -r, --rc-file [path] Custom rc file path (default path: ./.env-cmdrc(|.js|.json) 10 --silent Ignore any env-cmd errors and only fail on executed program failure. 11 --use-shell Execute the command in a new shell with the given environment 12 --verbose Print helpful debugging information 13 -x, --expand-envs Replace $var in args and command with environment variables 14 -h, --help output usage information
???? Advanced Usage
.rc file usage
For more complex projects, a .env-cmdrc file can be defined in the root directory and supports
as many environments as you want. Simply use the -e flag and provide which environments you wish to
use from the .env-cmdrc file. Using multiple environment names will merge the environment variables
together. Later environments overwrite earlier ones in the list if conflicting environment variables
are found.
.rc file ./.env-cmdrc
1{ 2 "development": { 3 "ENV1": "Thanks", 4 "ENV2": "For All" 5 }, 6 "test": { 7 "ENV1": "No Thanks", 8 "ENV3": "!" 9 }, 10 "production": { 11 "ENV1": "The Fish" 12 } 13}
Terminal
1./node_modules/.bin/env-cmd -e production node index.js 2# Or for multiple environments (where `production` vars override `test` vars, 3# but both are included) 4./node_modules/.bin/env-cmd -e test,production node index.js
--no-override option
Prevents overriding of existing environment variables on process.env and within the current
environment.
--fallback file usage option
If the .env file does not exist at the provided custom path, then use the default
fallback location ./.env env file instead.
--use-shell
Executes the command within a new shell environment. This is useful if you want to string multiple commands together that share the same environment variables.
Terminal
1./node_modules/.bin/env-cmd -f ./test/.env --use-shell "npm run lint && npm test"
Asynchronous env file support
EnvCmd supports reading from asynchronous .env files. Instead of using a .env file, pass in a .js
file that exports either an object or a Promise resolving to an object ({ ENV_VAR_NAME: value, ... }). Asynchronous .rc
files are also supported using .js file extension and resolving to an object with top level environment
names ({ production: { ENV_VAR_NAME: value, ... } }).
Terminal
1./node_modules/.bin/env-cmd -f ./async-file.js node index.js
-x expands vars in arguments
EnvCmd supports expanding $var values passed in as arguments to the command. The allows a user
to provide arguments to a command that are based on environment variable values at runtime.
Terminal
1# $USER will be expanded into the env value it contains at runtime 2./node_modules/.bin/env-cmd -x node index.js --user=$USER
--silent suppresses env-cmd errors
EnvCmd supports the --silent flag the suppresses all errors generated by env-cmd
while leaving errors generated by the child process and cli signals still usable. This
flag is primarily used to allow env-cmd to run in environments where the .env
file might not be present, but still execute the child process without failing
due to a missing file.
???? Examples
You can find examples of how to use the various options above by visiting the examples repo env-cmd-examples.
????️ Environment File Formats
These are the currently accepted environment file formats. If any other formats are desired please create an issue.
.envaskey=value.env.jsonKey/value pairs as JSON.env.jsJavaScript file exporting anobjector aPromisethat resolves to anobject.env-cmdrcas valid json or.env-cmdrc.jsonin execution directory with at least one environment{ "dev": { "key1": "val1" } }.env-cmdrc.jsJavaScript file exporting anobjector aPromisethat resolves to anobjectthat contains at least one environment
???? Path Rules
This lib attempts to follow standard bash path rules. The rules are as followed:
Home Directory = /Users/test
Working Directory = /Users/test/Development/app
| Type | Input Path | Expanded Path |
|---|---|---|
| Absolute | /some/absolute/path.env | /some/absolute/path.env |
Home Directory with ~ | ~/starts/on/homedir/path.env | /Users/test/starts/on/homedir/path.env |
| Relative | ./some/relative/path.env or some/relative/path.env | /Users/test/Development/app/some/relative/path.env |
| Relative with parent dir | ../some/relative/path.env | /Users/test/Development/some/relative/path.env |
???? API Usage
EnvCmd
A function that executes a given command in a new child process with the given environment and options
options{object}command{string}: The command to execute (node,mocha, ...)commandArgs{string[]}: List of arguments to pass to thecommand(['-R', 'Spec'])envFile{object}filePath{string}: Custom path to .env file to read from (defaults to:./.env)fallback{boolean}: Should fall back to default./.envfile if custom path does not exist
rc{object}environments{string[]}: List of environment to read from the.rcfilefilePath{string}: Custom path to the.rcfile (defaults to:./.env-cmdrc(|.js|.json))
options{object}expandEnvs{boolean}: Expand$varvalues passed tocommandArgs(default:false)noOverride{boolean}: Prevent.envfile vars from overriding existingprocess.envvars (default:false)silent{boolean}: Ignore any errors thrown by env-cmd, used to ignore missing file errors (default:false)useShell{boolean}: Runs command inside a new shell instance (default:false)verbose{boolean}: Prints extra debug logs toconsole.info(default:false)
- Returns {
Promise<object>}: key is env var name and value is the env var value
GetEnvVars
A function that parses environment variables from a .env or a .rc file
options{object}envFile{object}filePath{string}: Custom path to .env file to read from (defaults to:./.env)fallback{boolean}: Should fall back to default./.envfile if custom path does not exist
rc{object}environments{string[]}: List of environment to read from the.rcfilefilePath{string}: Custom path to the.rcfile (defaults to:./.env-cmdrc(|.js|.json))
verbose{boolean}: Prints extra debug logs toconsole.info(default:false)
- Returns {
Promise<object>}: key is env var name and value is the env var value
???? Why
Because sometimes it is just too cumbersome passing a lot of environment variables to scripts. It is usually just easier to have a file with all the vars in them, especially for development and testing.
????Do not commit sensitive environment data to a public git repo! ????
???? Related Projects
cross-env - Cross platform setting of environment scripts
???? Special Thanks
Special thanks to cross-env for inspiration (uses the
same cross-spawn lib underneath too).
???? Contributing Guide
I welcome all pull requests. Please make sure you add appropriate test cases for any features added. Before opening a PR please make sure to run the following scripts:
npm run lintchecks for code errors and format according to ts-standardnpm testmake sure all tests passnpm run test-covermake sure the coverage has not decreased from current master
No vulnerabilities found.
Reason
30 commit(s) and 25 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 existing vulnerabilities detected
Reason
Found 5/7 approved changesets -- score normalized to 7
Reason
branch protection is not maximal on development and all release branches
Details
- Info: 'allow deletion' disabled on branch 'master'
- Info: 'force pushes' disabled on branch 'master'
- Warn: 'branch protection settings apply to administrators' is disabled on branch 'master'
- Info: 'stale review dismissal' is required to merge on branch 'master'
- Warn: required approving review count is 1 on branch 'master'
- Warn: codeowners review is required - but no codeowners file found in repo
- Info: 'last push approval' is required to merge on branch 'master'
- Warn: no status checks found to merge onto branch 'master'
- Info: PRs are required in order to make changes on branch 'master'
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/linux-tests.yml:1
- Warn: no topLevel permission defined: .github/workflows/windows-tests.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/linux-tests.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/toddbluhm/env-cmd/linux-tests.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/linux-tests.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/toddbluhm/env-cmd/linux-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/linux-tests.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/toddbluhm/env-cmd/linux-tests.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/linux-tests.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/toddbluhm/env-cmd/linux-tests.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/linux-tests.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/toddbluhm/env-cmd/linux-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/windows-tests.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/toddbluhm/env-cmd/windows-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/windows-tests.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/toddbluhm/env-cmd/windows-tests.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/windows-tests.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/toddbluhm/env-cmd/windows-tests.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/windows-tests.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/toddbluhm/env-cmd/windows-tests.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/linux-tests.yml:34
- Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 5 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 30 are checked with a SAST tool
Score
5.6
/10
Last Scanned on 2025-02-03
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More