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

curzon

v0.0.8

Published

CLI builder

Downloads

17

Readme

🪵 curzon

npm version npm downloads bundle size license

Why?

  • Generates beautiful help menu

  • Create Posix-like tools or advanced CLIs

  • Multiple arguments types

  • Supports nested commands

Install

# npm
npm install curzon

# yarn
yarn add curzon

# pnpm
pnpm install curzon

# bun
bun install curzon

Usage

class HelloCommand extends BaseCommand {
  static paths = ['test', 'hello'];

  static meta: Meta = {
    description: 'This command will say hello to you.',
  };

  name = options.positional('name');

  async run() {
    console.log(`helooooooo ${this.name}!`);
  }
}

const cli = createCli({
  appName: 'Greeting Tool!',
  description: 'Tool for greeting people.',
  version: '1.0.03',
  binaryName: 'greet',
  color: 'yellow',
});

cli.use([HelloCommand]);

cli.run();

Root command

This can be useful when you want to create a Posix-like tool.

class RootCommand extends BaseCommand {
  static meta: Meta = {
    description: 'This is the root command.',
  };

  async run() {
    console.log('This is the root command.');
  }
}

const cli = createCli({
  appName: 'Greeting Tool!',
  description: 'Tool for greeting people.',
  version: '1.0.03',
  binaryName: 'greet',
  color: 'yellow',
});

cli.run({
  rootCommand: RootCommand,
});

By default, help menu will be shown for the root command, if any other command is not specified. Normally help menu for the whole cli would be shown.

Paths

Commands are matched using paths property.

class HelloCommand extends BaseCommand {
  static paths = ['test', 'hello'];

  async run() {
    console.log('Hello!');
  }
}

class TestCommand extends BaseCommand {
  static paths = ['test'];

  async run() {
    console.log('Test!');
  }
}
$ greet test hello # Hello!
$ greet test # Test!

With positional arguments

class TestCommand extends BaseCommand {
  static paths = ['test', 'hello'];

  async run() {
    console.log(`Hello test!`);
  }
}
class HelloCommand extends BaseCommand {
  static paths = ['test'];

  name = options.positional('name');

  async run() {
    console.log(`Hello ${this.name}!`);
  }
}

Positional arguments will work with HelloCommand only if they don't match the paths of TestCommand.

$ greet test hello # Hello test!
$ greet test john # Hello john!

Theme

You can specify a theme color for your CLI in the createCLI.

Options

Available options:

  • boolean
class HelloCommand extends BaseCommand {
  static paths = ['test', 'hello'];

  test = options.boolean('test', {
      short: 't',
  });

  async run() {}
}
$ greet test hello --test # or -t
  • positional
class HelloCommand extends BaseCommand {
  static paths = ['test', 'hello'];

  name = options.positional('name');

  async run() {}
}
$ greet test hello john

[!NOTE] Order of positional arguments corresponds to the order of their declaration in the class.

  • string
class HelloCommand extends BaseCommand {
  static paths = ['test', 'hello'];

  name = options.string('name', {
      short: 'n',
  });

  async run() {}
}
$ greet test hello --name john # or -n john, or --name="john"
  • number
class HelloCommand extends BaseCommand {
  static paths = ['test', 'hello'];

  age = options.number('age', {
      short: 'a',
  });

  async run() {}
}
$ greet test hello --age 20 # or -a 20

Number is parsed using parseFloat function and then checked if it's not NaN.

  • array
class HelloCommand extends BaseCommand {
  static paths = ['test', 'hello'];

  names = options.array('names', {
      short: 'n',
  });

  async run() {}
}
$ greet test hello --names john --names alice # or -n john -n alice

Published under the MIT license. Made by @malezjaa and community 💛