Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 2.25 KB

README.md

File metadata and controls

74 lines (51 loc) · 2.25 KB
Raw

npmx

Build and Deploy semantic-release npm version

An advanced CLI interface for npm

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 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.

{
  "theme": "Dracula"
}

Screenshots

asciicast

Home

home page

Dependency Info

dep info

Search

search page

Package

package page

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 /