# README

![child-shell](https://raw.githubusercontent.com/rannn505/child-shell/master/icon/icon.svg?sanitize=true)

#### Child Shell

Node.js bindings 🔗 for shell

[![npm@latest](https://img.shields.io/npm/v/child-shell/latest?color=%2329405B\&style=flat-square) ](https://www.npmjs.com/package/child-shell)[![npm@next](https://img.shields.io/npm/v/child-shell/next?color=%230C131B\&style=flat-square)](https://www.npmjs.com/package/child-shell)

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/rannn505/child-shell/CI?style=flat-square) ](readme)[![Jest](https://img.shields.io/badge/tested_with-jest-99424f.svg?style=flat-square) ](https://jestjs.io/)[![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://prettier.io/)

[![NPM Downloads](https://img.shields.io/npm/dt/child-shell.svg?style=flat-square) ](https://npm-stat.com/charts.html?package=child-shell)[![GitHub Stars](https://img.shields.io/github/stars/rannn505/child-shell?style=social) ](https://github.com/rannn505/child-shell/stargazers)[![License](https://img.shields.io/github/license/rannn505/child-shell?color=%23000000\&style=flat-square)](https://github.com/rannn505/child-shell/blob/master/LICENSE.md)

* [About](#about)
* [Documentation](#documentation)
* [Contributing](#contributing)
* [License](#license)

&#x20;

### About

[Node.js](https://github.com/nodejs/node/blob/master/README.md) is one of the successful, widely-used, and popular open-source projects on this earth. It was created to allow it's users to run JavaScript everywhere.

[Shell](https://en.wikipedia.org/wiki/Shell_\(computing\)) is the most usable user program on any computer, it is an integral part of our work and almost every task starts and ends with a command execution. It was created to allow it's users to interact with their OS.

**child-shell** creates a comprehensive binding between the two, exposes a proven yet easy API to interact with any shell directly from node runtime. Combine JavaScript code with shell based scripts to complete any type of task you ever imagined.

### Documentation

Learn about using child-shell on the official site!

* Getting started
* Configuring child-shell
* Useful Tips
* API Reference
* Shell packages:
  * [node-bash](packages/node-bash)
  * [node-powershell](packages/node-powershell)

### Contributing

Development of **child-shell** happens transparently on its [GitHub repo](https://github.com/rannn505/child-shell).\
Read the [contributing guide](contributing) to learn how to propose bugfixes and improvements, and how to build and test your changes.\
Future plans for **child-shell** are visible on its [board](https://github.com/rannn505/child-shell/projects/%3C%3E). These plans are subject to frequent changes, and will be greatly affected by your feedback.

### License

**child-shell** © is [MIT licensed](license).\
Created by [rannn505](https://github.com/rannn505).
