# subshell

> Boot an interactive subshell from node. Useful for custom command-line environments.

Latest version **0.0.0** (published 2014-02-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install subshell
pnpm add subshell
yarn add subshell
bun add subshell
```

Provides the command `subshell`.

## 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.0.0 |
| Published | 2014-02-26 |
| First published | 2014-02-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Hugh Kennedy |
| Maintainers | hughsk |
| Keywords | subshell, spawn, terminal, wrap, override, bash |

## Links

- npm: https://www.npmjs.com/package/subshell
- Repository: https://github.com/hughsk/subshell
- Issues: https://github.com/hughsk/subshell/issues
- npm.io page: https://npm.io/package/subshell

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.0.0 (latest) — 2014-02-26

## README

# subshell [![Flattr this!](https://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=hughskennedy&url=http://github.com/hughsk/subshell&title=subshell&description=hughsk/subshell%20on%20GitHub&language=en_GB&tags=flattr,github,javascript&category=software)[![experimental](http://hughsk.github.io/stability-badges/dist/experimental.svg)](http://github.com/hughsk/stability-badges) #

Boot an interactive subshell from node. Useful for custom command-line
environments.

## Usage ##

[![subshell](https://nodei.co/npm/subshell.png?mini=true)](https://nodei.co/npm/subshell)

### `subshell([cwd], [env], [exit])` ###

Spawns a subshell appropriate for your system, and wires up node's stdio
to the shell. Optionally, you can also pass:

* A `cwd` string, for the directory to run your shell from.
* An `env` object, to override the shell's environment variables.
* An `exit` callback with the signature `(err, code)`, called when the shell
  closes.

## License ##

MIT. See [LICENSE.md](http://github.com/hughsk/subshell/blob/master/LICENSE.md) for details.

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