# clean-run

> [![NPM](https://img.shields.io/npm/v/clean-run.svg)](https://npm.im/clean-run) ![License](https://img.shields.io/npm/l/clean-run.svg) ![Downloads](https://img.shields.io/npm/dt/clean-run.svg)

Latest version **1.0.2** (published 2021-05-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install clean-run
pnpm add clean-run
yarn add clean-run
bun add clean-run
```

Provides the command `clean-run`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2021-05-27 |
| First published | 2021-05-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Gerald |
| Maintainers | gera2ld |

## Links

- npm: https://www.npmjs.com/package/clean-run
- Repository: https://github.com/gera2ld/clean-run
- Homepage: https://github.com/gera2ld/clean-run#readme
- Issues: https://github.com/gera2ld/clean-run/issues
- npm.io page: https://npm.io/package/clean-run

## Recent versions

- 1.0.2 (latest) — 2021-05-27
- 1.0.1 — 2021-05-25
- 1.0.0 — 2021-05-25

## README

# clean-run

[![NPM](https://img.shields.io/npm/v/clean-run.svg)](https://npm.im/clean-run)
![License](https://img.shields.io/npm/l/clean-run.svg)
![Downloads](https://img.shields.io/npm/dt/clean-run.svg)

Run a Node.js script in a clean environment without caring about the dependencies. This is a `deno run` alternative that works for Node.js.

Requires Node.js >= 14.14.0.

## Motivation

When running a CI script, it is likely that we don't need all dependencies defined in a `package.json`. It might take relatively long time and high bandwidth to install all of them, especially when there are Electron and its friends. In areas with low bandwidth or poor network connections this may be a bigger problem as installation may fail and we have to care about packages that we don't even need.

If you are familiar with Deno, you will miss the feature to run a script with all the dependencies from remote. With `clean-run` you can easily run a script like that in Node.js.

## How does this work?

`clean-run` scans the entry script file to see what packages it really depends on and only install those needed. We don't have to set mirrors and wait for large packages that are not even required.

## Usage


```
Usage:

$ clean-run [options] <entryFile> [other arguments ...]

  <entryFile>   path to the main script, set to - if piped from stdin

Options:

  -s            suppress npm logs
```

You will need to install this one dependency first.

```bash
$ npm install clean-run
$ clean-run my-script.js
```

Or you can use npx to get a one-liner:

```bash
$ npx clean-run -s my-script.js
```

You can even run a remote script directly (try it by yourself 👇🏻):

```bash
$ curl -fsSL https://raw.githubusercontent.com/gera2ld/clean-run/master/demos/cowsay.js | npx clean-run -s -
```

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