npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

npm-commander

v1.1.1

Published

```markdown # npm-commander

Downloads

9

Readme

# npm-commander

A simple utility to run npm commands programmatically.

## Installation

Install `npm-commander` via npm:

```sh
npm install npm-commander

Usage

Synchronous Usage

You can use the synchronous methods provided by npm-commander to run npm commands.

const npmCommander = require('npm-commander');

// Install a package
npmCommander.install('express');

// Uninstall a package
npmCommander.uninstall('express');

// Update a package
npmCommander.update('express');

Asynchronous Usage

You can also use the asynchronous methods provided by npm-commander to run npm commands.

const npmCommander = require('npm-commander');

(async () => {
    try {
        // Install a package
        await npmCommander.AsyncFunctions.install('express');
        
        // Uninstall a package
        await npmCommander.AsyncFunctions.uninstall('express');
        
        // Update a package
        await npmCommander.AsyncFunctions.update('express');
    } catch (error) {
        console.error(`Error: ${error.message}`);
    }
})();

Additional Commands

npm-commander also provides additional npm commands.

const npmCommander = require('npm-commander');

// Get npm help
console.log(npmCommander.npm.Help());

// Get npm version
console.log(npmCommander.npm.Version());

API

Synchronous Methods

  • install(packageName, options)
  • uninstall(packageName)
  • update(packageName)

Asynchronous Methods

  • AsyncFunctions.install(packageName, options)
  • AsyncFunctions.uninstall(packageName)
  • AsyncFunctions.update(packageName)

Additional npm Commands

  • npm.Help()
  • npm.Version()

Handling Errors

The asynchronous methods throw errors if the npm command fails. Handle errors using try-catch blocks.

const npmCommander = require('npm-commander');

(async () => {
    try {
        await npmCommander.AsyncFunctions.install('express');
    } catch (error) {
        console.error(`Error installing package: ${error.message}`);
    }
})();

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Links