Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sigoden/clii
Easily build a cli app.
https://github.com/sigoden/clii
command-line command-runner javascript make
Last synced: 16 days ago
JSON representation
Easily build a cli app.
- Host: GitHub
- URL: https://github.com/sigoden/clii
- Owner: sigoden
- License: apache-2.0
- Created: 2022-02-14T11:08:55.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-24T00:56:51.000Z (almost 3 years ago)
- Last Synced: 2024-12-02T09:25:04.909Z (21 days ago)
- Topics: command-line, command-runner, javascript, make
- Language: TypeScript
- Homepage:
- Size: 625 KB
- Stars: 41
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Clii
Easily build a cli app.
Write some functions, jsdoc it, clii automatically turns it into a cli.
- [Clii](#clii)
- [Quick Start](#quick-start)
- [Cli Tool](#cli-tool)
- [License](#license)
## Quick Start
Install clii package.
```
npm i clii
yarn add clii
```
Write some js code
```js
/**
* A simple task
* @param {Object} options
* @param {number} options.num - Num variable
* @param {("prod"|"dev"|"stage")} options.mode - Build mode
*/
export async function task(options) {
console.log(options);
}
```
Add follow content to your file.
```js
import clii from "clii";
clii(import.meta.url);
```
All done.
What an easy way to build the cli app.
Try it in your terminal
```
$ node index.mjs task1 -h
index.mjs task1 [options]
Options:
--version Show version number [boolean]
-f, --file Specific clii file [string]
-w, --workdir Specific working directory [string]
--num Num variable [number]
--mode Build mode [string] [choices: "prod", "dev", "stage"]
-h, --help Show help [boolean]
$ node index.mjs task --num 3 --mode prod
{ num: 3, mode: 'prod' }
```
`clii` parse your ast js module file, generate cli interface according comments and exports semantics.
Export variable `settings` will be parsed as global options.
```
export const settings = {
// Default port number
port: 3000,
};
```
```
Options:
--port Default port number [number] [default: 3000]
```
Export function `cmd2` will be parsed as subcommand. It's parameters will be parsed as subcommand's options.
```
Commands:
demo.mjs cmd2 [options] Another command
```
The export default function will be th default command.
## Cli Tool
Since `clii` can run js functions directly from cli, it can be used as task runner / build tool.
By default, `clii` looks for file `cliifile.mjs` in the current directory and upwards, so you can invoke it from any subdirectory of your project.
You can organize your project scripts with `cliifile.mjs` to provide unified entrypoint and help information.
```js
export function lint() {}
/**
* Build
* @param {Object} options
* @param {boolean} options.prod
*/
export function build(options) {
lint();
}
```
```
$ clii
Usage: clii [options]
Commands:
clii lint
clii build [options] Build
Options:
--version Show version number [boolean]
-f, --file Specific clii file [string]
-w, --workdir Specific working directory [string]
-h, --help Show help [boolean]
$ clii build
$ clii lint
```
## License
[Apache-2.0](LICENSE)