https://github.com/yjl9903/breadc
🥪 Yet another Command Line Application Framework with fully TypeScript support
https://github.com/yjl9903/breadc
cli command-line framework typescript vscode
Last synced: about 1 month ago
JSON representation
🥪 Yet another Command Line Application Framework with fully TypeScript support
- Host: GitHub
- URL: https://github.com/yjl9903/breadc
- Owner: yjl9903
- License: mit
- Created: 2022-06-20T04:55:38.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-22T08:33:14.000Z (about 1 year ago)
- Last Synced: 2025-02-23T09:13:59.771Z (about 1 year ago)
- Topics: cli, command-line, framework, typescript, vscode
- Language: TypeScript
- Homepage: https://breadc.onekuma.cn/
- Size: 3.23 MB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🥪 Breadc
[](https://deepwiki.com/yjl9903/Breadc)
[](https://www.npmjs.com/package/breadc)
[](https://github.com/yjl9903/Breadc/actions/workflows/ci.yml)
[](https://codecov.io/gh/yjl9903/Breadc)
Yet another **Command Line Application Framework** desgined for **[TypeScript](https://www.typescriptlang.org/)**.
- **TypeScript Infer**: infer command arguments, option values, and action signatures in IDE automatically
- **Command**: support default command, command alias, and nested sub-commands like `git remote add `
- **Group**: organize commands by modules and build large multi-command CLI applications with clear structure
- **Option**: support boolean, required, optional, spread options, `--no-*` negation, and `--` passthrough arguments
- **Middleware**: support middleware pipeline and unknown option handling
- **Builtin CLI Features**: provide common help / version options and i18n support out of the box
- **Toolkits**: contains many useful tools to build your next CLI application, such as [ansi color](https://github.com/yjl9903/Breadc/tree/main/packages/color), [process death handler](https://github.com/yjl9903/Breadc/tree/main/packages/death), [shell compelete script generation](https://github.com/yjl9903/Breadc/tree/main/packages/complete) and so on.
## Installation
```bash
npm i breadc
```
## Usage
Try [./examples/echo.ts](./examples/echo.ts).
```ts
import { breadc } from 'breadc';
const cli = breadc('echo', { version: '1.0.0' })
.option('--host ', 'specify hostname', { initial: 'localhost' })
.option('--port ', 'specify port', { initial: '3000', cast: (t) => +t });
cli.command('[message]', 'Say something!').action((message, option) => {
console.log(message ?? 'You can say anything!');
const { host, port } = option; // { host: string, port: number, '--': string[] }
console.log(`Host: ${host}`);
console.log(`Port: ${port}`);
});
cli.run(process.argv.slice(2)).catch((err) => console.error(err));
```
If you are using IDEs that support TypeScript (like [Visual Studio Code](https://code.visualstudio.com/)), input something using `option`, and then you will find the `option` is automatically typed with `{ host: string, port: number }`. In the figure below, [Visual Studio Code](https://code.visualstudio.com/) will automatically infer that the type of `option.host` is `string` and the type of `option.port` is `number`.
## Inspiration
- [cac](https://github.com/cacjs/cac): Simple yet powerful framework for building command-line apps.
- [Commander.js](https://github.com/tj/commander.js): Node.js command-line interfaces made easy.
- [TypeScript: Documentation - Template Literal Types](https://www.typescriptlang.org/docs/handbook/2/template-literal-types.html)
## License
MIT License © 2023 [XLor](https://github.com/yjl9903)