> For the complete documentation index, see [llms.txt](https://rt.coolstone.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rt.coolstone.dev/install.md).

# Install

## Install

Install via NPM

```bash
[sudo] npm i remoterm -g
```

### Install in a project

If you want to install and run Remoterm in a project, install it and then require it.

```bash
npm i remoterm
```

```javascript
require('remoterm') // will start Remoterm
```