# 3h-cli > A cli program lib. Latest version **4.0.0** (published 2023-07-28) · MIT license · 0 weekly downloads ## Install ```sh npm install 3h-cli pnpm add 3h-cli yarn add 3h-cli bun add 3h-cli ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 4.0.0 | | Published | 2023-07-28 | | First published | 2018-02-20 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 14.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1 | | Author | 3h | | Maintainers | 3h | | Keywords | cli, 3h | ## Links - npm: https://www.npmjs.com/package/3h-cli - Repository: https://github.com/huang2002/3h-cli - Homepage: https://github.com/huang2002/3h-cli#readme - Issues: https://github.com/huang2002/3h-cli/issues - npm.io page: https://npm.io/package/3h-cli ## Alternatives - [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads - [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads - [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads - [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads - [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads ## Recent versions - 4.0.0 (latest) — 2023-07-28 - 3.0.0 — 2020-04-09 - 2.2.1 — 2020-02-27 - 2.2.0 — 2020-02-27 - 2.1.1 — 2020-02-26 - 2.1.0 — 2020-02-26 - 2.0.0 — 2020-02-25 - 1.5.0 — 2018-07-07 - 1.4.4 — 2018-07-01 - 1.4.3 — 2018-06-23 - 1.4.2 — 2018-06-23 - 1.4.1 — 2018-06-01 - 1.4.0 — 2018-05-26 - 1.3.2 — 2018-05-26 - 1.3.1 — 2018-05-26 - … 10 more at https://npm.io/package/3h-cli/versions ## README # 3h-cli > A cli program lib. ## Example ```bash npm i 3h-cli ``` ```js /* my-cli.js */ #!/usr/bin/env node const { Program } = require('3h-cli'); const program = new Program('my-cli', { title: 'This is my-cli.', }); program .action({ name: 'foo', help: 'action foo' }) .action({ name: 'bar', help: 'action bar' }) .option({ name: '--baz', alias: '-b', value: '', help: 'option baz' }) .option({ name: '--help', alias: '-h', help: 'show help info\nlike this' }) .rest({ value: '[args...]', help: 'other args' }) .parse(process.argv) .then(args => { console.log('received actions:', args.actions); console.log('received options:', args.options); console.log('other args:', args.rest); console.log('--------------------------------'); if (args.options.has('--help')) { return program.help(); } }, err => { console.error(err); process.exit(1); }) ``` ```bash $ ./my-cli.js --help received actions: [] received options: Map { '--help' => [] } other args: [] -------------------------------- This is my-cli. Usage: my-cli [options] -- [args...] actions: foo action foo bar action bar Options: --baz, -b option baz --help, -h show help info like this -- [args...] other args ``` ## API Reference *The API reference is written in TypeScript style.* ```ts class Args { constructor( actions: string[], options: Map, rest: string[] ); readonly actions: string[]; readonly options: Map; readonly rest: string[]; /** * A utility method that returns * the specific option if it exists * or an empty array otherwise */ getOption(name: string): string[]; } interface Args { actions: string[]; options: Map; rest: string[]; } /** * Parse arguments from the given array of strings * @example * ```js * const rawArgs = ['foo', '--bar', '-ac', '666', '--', '10', '11'], * optionAliases = new Map([['-a', '--baz']]); * * console.log(parse(rawArgs, optionAliases)); * // { * // actions: ['foo'], * // options: Map { * // '--bar' => [], * // '--baz' => [], * // '-c' => ['666'] * // }, * // rest: ['10', '11'] * // } * ``` */ function parse( rawArgs: string[], optionAliases?: Map ): Args; interface ActionDefinition { name: string; help?: string; } interface OptionDefinition { name: string; alias?: string | null; value?: string; help?: string; } interface RestDefinition { value: string; help?: string; } type ProgramOptions = Partial<{ title: string; helpInfoIndent: number; helpInfoGap: number; ignoreUnknownActions: boolean; ignoreUnknownOptions: boolean; }>; class Program { constructor(name: string, options?: Readonly); /** * The name/title of the program * (displayed in built-in help info) */ readonly name: string; title: string; /** * Style parameters of built-in help info */ helpInfoIndent: number; helpInfoGap: number; /** * Whether to ignore undefined actions/options * (By default, undefined options will * cause the parsing promise to be rejected * but unknown actions won't) */ ignoreUnknownActions: boolean; ignoreUnknownOptions: boolean; /** * Register a action, an option or rest options */ action(definition: ActionDefinition): this; option(definition: OptionDefinition): this; rest(description: RestDefinition | null): this; /** * Parse the arguments * @returns a promise solved with parsed args on success * or rejected on unknown actions/options */ parse(rawArgs: string[]): Promise; /** * Display built-in help info * (the help info is generated from action and * option definitions; you can append other help * info after this like the example below) * @example * ```js * program.parse(process.argv) * .then(args => { * if (args.options.has('--help')) { * program.help(); * console.log('\nExamples'); * console.log(' my-cli foo --bar'); * } else { * // ... * } * }, err => { * // ... * }); * ``` */ help(): void; } ``` --- _Source: https://npm.io/package/3h-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._