Package Health Score

57 / 100

security
No known security issues
popularity
Recognized
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
4.0.1	\|	09/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.0.1	\|	01/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.2.0	\|	02/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.0	\|	12/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.3.0	\|	11/2016	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (13,396)

GitHub Stars: 79
Forks: 17
Contributors: 8

Direct Usage Popularity

The npm package shell-env receives a total of 13,396 downloads a week. As such, we scored shell-env popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package shell-env, we found that it has been starred 79 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 8
Funding: Yes

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 2
Open PR: 0
Last Release: 3 years ago
Last Commit: 3 years ago

Further analysis of the maintenance status of shell-env based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for shell-env is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: ^12.20.0 || ^14.13.1 || >=16.0.0

Age: 9 years
Dependencies: 3 Direct
Versions: 15
Install Size: 5.8 kB
Dist-tags: 1
# of Files: 5
Maintainers: 2
TS Typings: No

shell-env has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use shell-env?

To help you get started, we've collected the most common ways that shell-env is being used within popular public projects.

appium / appium-desktop / app / main.js View on Github

import rebuildMenus from './main/menus';
import shellEnv from 'shell-env';
import fixPath from 'fix-path';
import settings from './shared/settings';

let mainWindow = null;
const isDev = process.env.NODE_ENV === 'development';

if (isDev) {
  require('electron-debug')(); // eslint-disable-line global-require
}

if (!isDev) {
  // if we're running from the app package, we won't have access to env vars
  // normally loaded in a shell, so work around with the shell-env module
  const decoratedEnv = shellEnv.sync();
  process.env = {...process.env, ...decoratedEnv};

  // and we need to do the same thing with PATH
  fixPath();
}
setSavedEnv();

app.on('window-all-closed', () => {
  app.quit();
});


const installExtensions = async () => {
  if (isDev) {
    const installer = require('electron-devtools-installer'); // eslint-disable-line global-require
    const extensions = [

View more ways to use shell-env

shell-env

Get environment variables from the shell

Especially useful for Electron apps as GUI apps on macOS doesn't inherit the environment variables defined in your dotfiles (.bash_profile/.zshrc/etc).

Install

$ npm install shell-env

Usage

import {shellEnv} from 'shell-env';

console.log(await shellEnv());
//=> {TERM_PROGRAM: 'Apple_Terminal', SHELL: '/bin/zsh', ...}

console.log(await shellEnv('/bin/bash'));
//=> {TERM_PROGRAM: 'iTerm.app', SHELL: '/bin/zsh', ...}

API

Note that for Bash, it reads .bash_profile, but not .bashrc.

shellEnv(shell?)

Return a promise for the environment variables.

shellEnvSync(shell?)

Returns the environment variables.

shell

Type: string
Default: User default shell

Shell to read the environment variables from.

shell-path - Get the $PATH from the shell
fix-path - Fix the $PATH on macOS when run from a GUI app
shell-history - Get the command history of the user's shell

Maintainers

shell-env dependencies

default-shell execa strip-ansi

shell-env development dependencies

ava tsd xo

FAQs

What is shell-env?

Get environment variables from the shell. Visit Snyk Advisor to see a full health score report for shell-env, including popularity, security, maintenance & community analysis.

Is shell-env popular?

The npm package shell-env receives a total of 13,396 weekly downloads. As such, shell-env popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is shell-env well maintained?

We found indications that shell-env is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is shell-env safe to use?

The npm package shell-env was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 17 November-2024, at 12:00 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP