# hyper-shellect

> cross-platform shell selection for hyper

Latest version **0.3.7** (published 2019-01-09) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install hyper-shellect
pnpm add hyper-shellect
yarn add hyper-shellect
bun add hyper-shellect
```

Provides the command `hyper-shellect`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.7 |
| Published | 2019-01-09 |
| First published | 2019-01-03 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 353.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jos Kore Wingfield |
| Maintainers | joskore |

## Links

- npm: https://www.npmjs.com/package/hyper-shellect
- Repository: https://github.com/joskore/hyper-shellect
- Homepage: https://github.com/joskore/hyper-shellect#readme
- Issues: https://github.com/joskore/hyper-shellect/issues
- npm.io page: https://npm.io/package/hyper-shellect

## Dependencies (2)

- [path](https://npm.io/package/path.md) ^0.12.7
- [colors](https://npm.io/package/colors.md) ^1.3.3

## Recent versions

- 0.3.7 (latest) — 2019-01-09
- 0.3.6 — 2019-01-08
- 0.3.5 — 2019-01-08
- 0.3.4 — 2019-01-08
- 0.3.3 — 2019-01-08
- 0.3.2 — 2019-01-04
- 0.3.0 — 2019-01-04
- 0.2.1 — 2019-01-04
- 0.2.0 — 2019-01-04
- 0.1.1 — 2019-01-03
- 0.1.0 — 2019-01-03

## README

# hyper-shellect

hyper-shellect is a small hyper plugin that lets you configure a menu of multiple shells that you can select from and switch between.

you can add and remove as many shells as your little heart desires, they're all stored in your `.hyper.js`

## Preview

![hyper-shellect preview gif](hyper-shellect.gif)

## Install
1. Run `hyper i hyper-shellect` or manually add `hyper-shellect` to your hyper plugins.
2. Add the shellect config to .hyper.js:
    ```
    shellect: {
      colorsEnabled: true,
      shells: [
        {
          shellName: 'zsh',
          shellCmd: '/bin/zsh'
        },
        {
          shellName: 'bash',
          shellCmd: '/bin/bash'
        },
        {
          shellName: 'node',
          shellCmd: '/usr/local/bin/node'
        },
        {
          shellName: 'python',
          shellCmd: '/usr/bin/python'
        },
      ]
    },
    ```
3. Away you go!

## Adding a shell

1. Open your `.hyper.js` configuration file
2. Add a new object to `shellect.shells` with the shellName (a meaningful label) and the full `shellCmd` text for the shell:
    - `{ shellName: 'python', shellCmd: '/usr/bin/python' }`
    - if the command is on your PATH, you may be able to simply use the command name instead of the full path
3. Re-run the script, and the new shell will be available!

## Running Out of Hyper

The project can also be utilized outside of Hyper, if you just want a simple terminal switcher.

1. `git clone https://github.com/joskore/hyper-shellect` or `npm i hyper-shellect` wherever you'd like the tool installed
2. Create a `.env.json` file in the root of the installed project with the same shellect configuration object as used by Hyper
3. Run `npm start` from the root or `node /path/to/run.js` from anywhere
4. Be content!

---
_Source: https://npm.io/package/hyper-shellect · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._