https://github.com/terminal-junkies/npmx

Advanced CLI for npm
https://github.com/terminal-junkies/npmx

blessed cli command-line npm terminal

Last synced: 3 months ago
JSON representation

Advanced CLI for npm

• Host: GitHub
• URL: https://github.com/terminal-junkies/npmx
• Owner: terminal-junkies
• License: mit
• Created: 2020-09-30T02:00:36.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-12-03T05:17:17.000Z (almost 4 years ago)
• Last Synced: 2024-07-21T07:47:28.403Z (4 months ago)
• Topics: blessed, cli, command-line, npm, terminal
• Language: JavaScript
• Homepage:
• Size: 1.8 MB
• Stars: 121
• Watchers: 8
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# npmx

![Build and Deploy](https://github.com/terminal-junkies/npmx/workflows/Build%20and%20Deploy/badge.svg)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![npm version](http://img.shields.io/npm/v/@terminal-junkies/npmx.svg?style=flat)](https://npmjs.org/package/@terminal-junkies/npmx "View this project on npm")

An advanced CLI interface for [npm](npmjs.com)

Features:

- Search packages from the terminal

- Run your project tasks from

- Install a selected package with one keystroke

- Run other npm tasks within your project

- Mnemonic key-bindings for installing packages

## Install

```

npm install --global @terminal-junkies/npmx

```

## Usage

```

npmx

```

## Color Schemes

The CLI can use a different color scheme other than the default one. Please set the `theme` value to any 

one of the themes from [blessed-themes](https://github.com/blessedjs/blessed-themes) in your config file at `~/.config/.npmx.json`

The Default theme used is `Dracula`. The config file will be automatically created on the first time of invoking the CLI, if not you can also create manually in the below format.

```json

{

  "theme": "Dracula"

}

```

## Screenshots

[![asciicast](https://asciinema.org/a/7ajz46JAVDVR9nV5ZMwhLLzAT.svg)](https://asciinema.org/a/7ajz46JAVDVR9nV5ZMwhLLzAT)

### Home

![home page](screenshots/home.png)

### Dependency Info

![dep info ](screenshots/dep-info.png)

### Search

![search page](screenshots/search.png)

### Package

![package page](screenshots/package.png)

## FAQS

### How do I quit this thing?

You can press `q` to quit the program at any time.

### How do I scroll the package readme?

You can use `up` and `down` arrow keys to scroll. And you can also make use of vim navigation keys like `j,k,gg,G` to scroll.

### How do I close the Dependency Info popup?

Press `Esc` to close the popup.

### How can I see the keyboard shortcuts?

The keyboard shortcuts will be displayed at the bottom of the screen for each page.

### How do I close the project task terminal after the task is completed?

Press `Esc` to close the terminal window for project tasks.

### Does it support vi/vim navigation keys in the lists?

Yes. You can use j,k,gg,G,l and /