https://github.com/ytakahashi/nps

Interactive npm-scripts runner for Node.js projects.
https://github.com/ytakahashi/nps

cli deno npm npm-scripts yarn

Last synced: 3 months ago
JSON representation

Interactive npm-scripts runner for Node.js projects.

• Host: GitHub
• URL: https://github.com/ytakahashi/nps
• Owner: ytakahashi
• License: mit
• Created: 2021-03-06T22:25:15.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-12T04:17:23.000Z (4 months ago)
• Last Synced: 2024-10-14T16:21:01.950Z (4 months ago)
• Topics: cli, deno, npm, npm-scripts, yarn
• Language: TypeScript
• Homepage:
• Size: 274 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# nps

[![deno land](https://img.shields.io/badge/deno.land/x/nps-lightgrey.svg?logo=deno&labelColor=black)](https://deno.land/x/nps)

[![tag](https://img.shields.io/github/tag/ytakahashi/nps.svg)](https://github.com/ytakahashi/nps)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![Actions Status](https://github.com/ytakahashi/nps/workflows/Deno/badge.svg)](https://github.com/ytakahashi/nps/actions/workflows/deno.yml)

Interactive npm-scripts runner for Node.js projects.

![image](./image/nps.gif)

## Install

```terminal

deno install --global --allow-read --allow-run --allow-env https://deno.land/x/nps/nps.ts

```

## Update

```terminal

deno install --global --force --reload --allow-read --allow-run --allow-env https://deno.land/x/nps/nps.ts

```

## Usage

Run following command in Node.js project.

```terminal

nps

```

If `package-lock.json` or `yarn.lock` or `pnpm-lock.yaml` exists in the directory, the appropriate command (`npm` or `yarn` or `pnpm`) will be executed to run the selected script.  

See `nps -h` for details.

### Filter npm-scripts

If an argument is provided, scripts are filtered by the value and prompt shows filtered items.  

If given value matches only one script, the command is run immediately.

### Pass arguments to command

Arguments after double dash (`--`) are treated as script command option like [npm run](https://docs.npmjs.com/cli/v7/commands/npm-run-script).  

All the arguments after the `--` are passed directly to selected script.