Socket
Book a DemoInstallSign in
Socket

shells

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

shells

Get a list of all unix shells for which user configuration files exist. Supports bash, zsh, and fish.

latest
Source
npmnpm
Version
2.0.0
Version published
Maintainers
1
Created
Source

shells

Get a list of all unix shells for which user configuration files exist. Supports bash, zsh, and fish.

Installation

npm install shells --save

Usage

const shells = require('shells')()

This module looks for the following files in your home directory:

~/.bashrc
~/.bash_profile
~/.config/fish/config.fish
~/.zshrc

It returns an array of the extant files, sorted by most recently modified:

[{
  file: '/Users/zeke/.zshrc',
  type: 'zsh'
}, {
  file: '/Users/zeke/.bashrc',
  type: 'bash'
}]

The first one on the list is probably the user's preferred shell, but there's no guarantee. If you just want to know the user's current shell, use process.env.SHELL, but be aware this isn't always accurate.

Tests

npm install
npm test

Dependencies

  • path-exists: Check if a path exists

Dev Dependencies

  • standard: JavaScript Standard Style
  • tap-spec: Formatted TAP output like Mocha's spec reporter
  • tape: tap-producing test harness for node and browsers

License

MIT

Generated by package-json-to-readme

Keywords

shell

FAQs

Package last updated on 28 May 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts