https://github.com/clercjs/clerc
🖖🏻 Clerc: The full-featured cli library.
https://github.com/clercjs/clerc
argparse args argument-parser argument-parsing arguments argv cac clerc cli cli-application cli-framework command-line command-line-tool commandline commandline-apps minimist node nodejs parse yargs
Last synced: 7 days ago
JSON representation
🖖🏻 Clerc: The full-featured cli library.
- Host: GitHub
- URL: https://github.com/clercjs/clerc
- Owner: clercjs
- License: mit
- Created: 2022-09-04T07:43:32.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-08T23:53:47.000Z (7 months ago)
- Last Synced: 2025-05-12T05:15:07.738Z (7 months ago)
- Topics: argparse, args, argument-parser, argument-parsing, arguments, argv, cac, clerc, cli, cli-application, cli-framework, command-line, command-line-tool, commandline, commandline-apps, minimist, node, nodejs, parse, yargs
- Language: TypeScript
- Homepage: https://clerc.js.org
- Size: 3.91 MB
- Stars: 135
- Watchers: 1
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-javascript - @clerc/monorepo - featured cli library. (Packages)
- awesome-cli-frameworks - Clerc - featured library for building CLI Apps in Node.js, Deno or Bun. It's strongly-typed, easy-to-use and flexible. ([JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) / Useful awesome list for Go cli)
README
Clerc is a full-featured library (tool set) for building CLI Apps in Node.js, Deno or Bun.
[](https://npmjs.org/package/clerc)
[](https://github.com/clercjs/clerc/actions/workflows/ci.yml)
[](https://npmjs.org/package/clerc)
[](https://github.com/clercjs/clerc/blob/main/package.json)
- [✨ Features](#-features)
- [😊 The simplest CLI example](#-the-simplest-cli-example)
- [📖 Documentation](#-documentation)
- [🦄 Examples](#-examples)
- [🤔 More...](#-more)
> [!NOTE]
> This package is ESM-only.
# ✨ Features
- **Lightweight** - Dependencies are bundled.
- **Plugin system** - Add rich features on demand.
- **Chainable APIs** - Composable.
- **Developer friendly** - Strongly typed, converts flags and parameters to camelCase.
- **Parses parameters** - No need to read them by yourself.
# 😊 The simplest CLI example
Install clerc, and create a file named `cli.mjs`:
```ts
import { Clerc } from "clerc";
Clerc.create() // Create a new Clerc instance
.scriptName("foo") // CLI Script Name
.description("A foo CLI") // CLI Description
.version("0.0.0") // CLI Version
.command(
"bar", // Command name
"A bar command", // Command description
)
.on(
"bar",
(
_ctx, // The command context, but we haven't used it yet
) => {
console.log("Hello, world from Clerc!");
},
)
.parse(); // Parse the arguments and run!
```
Then run: `node cli.mjs bar`. It should log in your shell: `Hello, world from Clerc!`
# 📖 Documentation
Please see https://clerc.so1ve.dev.
# 🦄 Examples
Check the examples made with `Clerc`:
- [Greeting](./examples/greeting) - The example from above
- [Bumpp](./examples/bumpp) - Reimplementation of [`Bumpp`](https://github.com/antfu/bumpp)'s CLI
# 🤔 More...
## Why using Clerc?
Clerc uses [`@clerc/parser`](https://github.com/clercjs/clerc/blob/main/packages/parser) to parse arguments. It is strongly-typed, which brings you better DX. It is powerful(supports custom type) and quite small and performant!
Clerc has a plugin system, which means you can add features on demand (e.g. auto completions, help text generation...). It also provides chainable APIs for better composability.
Clerc's flexible architecture and plugin system offer vast potential for further exploration and customization in diverse CLI application scenarios. There are more and more opportunities to leverage Clerc's capabilities to create unique and powerful command-line tools!
## 📝 License
[MIT](./LICENSE). Made with ❤️ by [Ray](https://github.com/so1ve)