CliteParser generate CLI from a class, each method generate a "command", each field generate an "option" :
// for Node usage:
#!/usr/bin/env node
import { cliteRun } from "clite-parser"; // after "npm install clite-parser"
// or for Deno usage:
#!/usr/bin/env -S deno run
import { cliteRun } from "https://deno.land/x/[email protected]/clite_parser.ts";
class Tool {
retry = 2;
webUrl = "none"; // fields are converted to kebab case as global options
no_color; // → --no-color
main() {
console.log("main command", this);
}
up() {
console.log("up command", this);
}
down(force, timeout) {
console.log("down command", { force, timeout }, this);
}
}
cliteRun(new Tool());
Plain text (without color and styles in markdown):
$ # with Node : "node example-lite-lite.mjs --help"
$ # or if the is shebang is present: "./example-lite-lite.mjs --help"
$ # with Deno : "deno run example-lite-lite.mjs --help"
$ # or if the is shebang is present:
$ ./example-lite-lite.ts --help
Usage: <Tool file> [Options] [command [command args]]
Commands:
main (default)
up
down <force> <timeout>
Options:
--retry=<RETRY> (default "2")
--web-url=<WEB_URL> (default "none")
--no-color=<NO_COLOR>
--help Show this help
# ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓ options ↓↓↓↓↓↓↓↓↓↓↓ ↓command↓ ↓cmd args↓
$ ./example-lite.ts --retry=4 --web-url=tttt --no-color down true 14
down command { force: "true", timeout: "14" } Tool { retry: "4", webUrl: "tttt", no_color: true }
$ ./example-lite.ts down true 14
down command { force: "true", timeout: "14" } Tool { retry: 2, webUrl: "none", no_color: undefined }
$ ./example-lite.ts --retry=4 --web-url=tttt --no-color
main command Tool { retry: "4", webUrl: "tttt", no_color: true }
Optional fields _<filed or method name>_desc
are displayed as description in
the help :
#!/usr/bin/env -S deno run -A
import { cliteRun } from "https://deno.land/x/[email protected]/clite_parser.ts";
class Tool {
_desc = "This tool is a little example of CliteParser"; // optional description
retry = 2;
webUrl = "none"; // fields are converted to kebab case as global options
no_color?: string | boolean; // → --no-color
_no_color_desc = "skip colorize"; // optional description for "no_color" field
_up_desc = "create and start"; // optional description for "up" command
main() {
console.log("main command", this);
}
up() {
console.log("up command", this);
}
down(force: boolean, timeout: number) {
console.log("down command", { force, timeout }, this);
}
}
if (import.meta.main) { // if the file is imported, do not execute this block
cliteRun(new Tool());
}
Plain text (without color and styles in markdown):
This tool is a little example of CliteParser
Usage: <Tool file> [Options] [command [command args]]
Commands:
main (default)
up create and start
down <force> <timeout>
Options:
--retry=<RETRY> (default "2")
--web-url=<WEB_URL> (default "none")
--no-color=<NO_COLOR> skip colorize
--help Show this help
- If there is only one method/command => this method is the default
- If the main method exist => main is the default
- else => no default method
$ ./example-lite.ts
main command Tool { retry: 2, webUrl: "none", no_color: undefined }
Fields and methods that start with "_" are ignored.
_privateData = 12;
_privmethod();
{
console.log("this method is not visible in the help (starts with '_')");
}
Note: this "private" method can be run by the CLI, it's useful during the development.
$ ./example-lite.ts
main command Tool { retry: 2, webUrl: "none", no_color: undefined }
$ ./example-lite.ts --no-color
main command Tool { retry: 2, webUrl: "none", no_color: true }
$ ./example-lite.ts --no-color=false
main command Tool { retry: 2, webUrl: "none", no_color: "false" }
$ ./example-lite.ts --no-color=true
main command Tool { retry: 2, webUrl: "none", no_color: "true" }
cliteRun(new Tool(), < optional CliteRunConfig > )
type CliteRunConfig = {
args?: string[]; // default : Deno.args or process.argv.slice(2)
dontPrintResult?: boolean; // default : false
noCommand?: boolean; // default : false
};
If the method run by cliteRun
return a value != undefined, it will be print in
stdout.
This behavior can be disabled with the config :
cliteRun(new Tool(), { dontPrintResult: true } )
cliteRun(new Tool(), { noCommand: true });
→ ./example-no-command.ts ---help
give :
This tool is a "no-command" example of CliteParser usage
Usage: <Tool file> [Options] [args]
Options:
--retry=<RETRY> (default "2")
--web-url=<WEB_URL> web URL ... (default "none")
--no-color=<NO_COLOR> skip colorize
--help Show this help
Run npm i clite-parser
and import with
import { cliteRun } from "clite-parser";
:
import { cliteRun } from "clite-parser"; // after "npm i clite-parser"
class Tool { ... }
cliteRun(new Tool());
See node usage examples:
Usage with --experimental-network-imports NodeJS option (without npm install) :
Import directly by http :
// run with "node --experimental-network-imports ./example.mjs"
import { cliteRun } from "https://deno.land/x/[email protected]/clite_parser.mjs";
And run the script with:
$ node --experimental-network-imports ./example.mjs
From https://stackblitz.com/edit/node-uywg3x?file=index.mjs&view=editor :
In the terminal :
$ node ./index.mjs
or
$ chmod +x ./index.mjs
$ ./index.mjs
main command Tool { retry: 2, webUrl: 'none', no_color: undefined }
From https://codesandbox.io/p/devbox/clite-parser-deno-hw33ww?file=%2Findex.ts%3A8%2C1 see Terminal