cleye

Strongly typed CLI development for Node.js

CLI
privatenumber/cleyecleye

README

undefined

cleye


The intuitive command-line interface (CLI) development tool.

Features


Minimal API surface
Powerful flag parsing
Strongly typed parameters and flags
Command support
Help documentation generation (customizable too!)

Install


  1. ``` shell
  2. npm i cleye
  3. ```

About


Cleyemakes it very easy to develop command-line scripts in Node.js. It handles argv parsing to give you strongly typed parameters + flags and generates --helpdocumentation based on the provided information.

Here's an example script that simply logs: `Good morning/evening !`:

greet.js:

  1. ``` ts
  2. import { cli } from 'cleye'

  4. // Parse argv
  5. const argv = cli({
  6.     name: 'greet.js',

  8.     // Define parameters
  9.     parameters: [
  10.         '<first name>', // First name is required
  11.         '[last name]' // Last name is optional
  12.     ],

  14.     // Define flags/options
  15.     flags: {

  17.         // Parses `--time` as a string
  18.         time: {
  19.             type: String,
  20.             description: 'Time of day to greet (morning or evening)',
  21.             default: 'morning'
  22.         }
  23.     }
  24. })

  26. const name = [argv._.firstName, argv._.lastName].filter(Boolean).join(' ')

  28. if (argv.flags.time === 'morning') {
  29.     console.log(`Good morning ${name}!`)
  30. } else {
  31.     console.log(`Good evening ${name}!`)
  32. }
  33. ```

🛠 In development, type hints are provided on parsed flags and parameters:

undefined Type hints for Cleye's output are very verbose and readable

📖 Generated help documentation can be viewed with the --helpflag:

  1. ``` shell
  2. $ node greet.js --help

  4. greet.js

  6. Usage:
  7.   greet.js [flags...] <first name> [last name]

  9. Flags:
  10.   -h, --help                 Show help
  11.       --time <string>        Time of day to greet (morning or evening) (default: "morning")
  12. ```

✅ Run the script to see it in action:

  1. ``` shell
  2. $ node greet.js John Doe --time evening

  4. Good evening John Doe!
  5. ```

Examples


Want to dive right into some code? Check out some of these examples:

greet.js : Working example from above
npm install : Reimplementation of npm install 's CLI
tsc : Reimplementation of TypeScript tsc 's CLI
snap-tweet : Reimplementation of snap-tweet 's CLI
pkg-size : Reimplementation of pkg-size 's CLI