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

@guoyunhe/create-cli

v1.8.0

Published

Initialize a Node.js command line tool project

Downloads

17

Readme

@guoyunhe/create-cli

Initialize a Node.js command line tool project

Get Started

Create a new project

npm create @guoyunhe/cli my-cli

Initialize an existing project

cd my-cli
npm init @guoyunhe/cli

Project structure

├── dist # Build output
│   ├── index.js # CJS API entry
│   ├── index.mjs # ESM API entry
│   ├── index.d.ts # TypeScript declaration
│   ├── my-cli.js # CJS CLI script
│   └── my-cli.mjs # ESM CLI script
├── src # Source code
│   ├── bin # CLI scripts
│   │   └── my-cli.ts
│   ├── index.test.ts # API unit test
│   └── index.ts # API entry (add all exports here)
├── .editorconfig
├── .gitignore
├── CHANGELOG.md
├── package.json
├── README.md
└── tsconfig.json

Package scripts

# Build output
npm run build
# Build output in watch mode
npm run watch
# Format source code
npm run format
# Check lint issues
npm run lint
# Run unit tests (support all jest command options)
npm test
# Run unit tests in watch mode
npm test -- --watch
# Update unit test snapshots
npm test -- -u

Advanced Options

Initial package version

1.0.0 by default.

npm create @guoyunhe/cli my-cli --package-version 0.1.0

Add multiple bin

Let's say, you want to add a new bin called health-check.

First, create src/bin/health-check.ts, with shebang #!/usr/bin/env node:

#!/usr/bin/env node

console.log('Doing health check...');

// Add your code...

Then, add bin entry to your package.json:

{
  "bin": {
    "health-check": "dist/health-check.js"
  }
}