🌆 citty


Elegant CLI Builder

- Zero dependency
- Fast and lightweight argument parser (based on native node utils)
- Smart value parsing with typecast and boolean shortcuts
- Nested sub-commands
- Lazy and Async commands
- Pluggable and composable API
- Auto generated usage and help

Usage

Install package:

``sh
npx nypm add -D citty
`

Import:

`js
import { defineCommand, runMain } from "citty";
`

Define main command to run:

`ts
import { defineCommand, runMain } from "citty";

const main = defineCommand({
meta: {
name: "hello",
version: "1.0.0",
description: "My Awesome CLI App",
},
args: {
name: {
type: "positional",
description: "Your name",
required: true,
},
friendly: {
type: "boolean",
description: "Use friendly greeting",
},
},
run({ args }) {
console.log(${args.friendly ? "Hi" : "Greetings"} ${args.name}!);
},
});

runMain(main);
`

Utils

$3

defineCommand is a type helper for defining commands.

$3

Runs a command with usage support and graceful error handling.

$3

Create a wrapper around command that calls runMain when called.

$3

Parses input args and runs command and sub-commands (unsupervised). You can access result key from returnd/awaited value to access command's result.

$3

Parses input arguments and applies defaults.

$3

Renders command usage to a string value.

$3

Renders usage and prints to the console

Development

- Clone this repository
- Install latest LTS version of Node.js
- Enable Corepack using corepack enable
- Install dependencies using pnpm install
- Run interactive tests using pnpm dev`

License

Made with 💛 Published under MIT License.