@jill64/ts-cli

＞ Solidly-Typed CLI Router

Installation

1npm i @jill64/ts-cli

Example

1import { App } from '@jill64/ts-cli'
2
3new App(
4  {
5    args: [
6      ['arg1', 'Argument 1'],
7      ['arg2', 'Argument 2'],
8      ['arg3', 'Argument 3']
9    ],
10    options: {
11      verbose: {
12        alias: 'V',
13        description: 'Verbose output'
14      },
15      host: {
16        alias: 'h',
17        description: 'Host name',
18        type: 'string'
19      }
20    },
21    optional: [
22      ['optional-1', 'Optional Argument 1'],
23      ['optional-2', 'Optional Argument 2'],
24      ['optional-3', 'Optional Argument 3']
25    ],
26    rest: {
27      placeholder: 'rest-argument',
28      description: 'Rest Argument'
29    },
30    codes: {
31      0: success,
32      1: failure
33    }
34  },
35  ({ args, options, optional, rest }) => {
36    // `<command> <arg1> <arg2> <arg3> [options] [optional1?] [optional2?] [optional3?] <...rest>`
37
38    options.verbose // boolean
39    options.host // string
40
41    // Allow 0 or 1 or void
42    return 0
43  }
44)

Add Route (Subcommands)

The add function defines a route.

1import { App } from '@jill64/ts-cli'
2
3new App(/* ... */)
4  .add(
5    'test',
6    {
7      // Config
8    },
9    () => {
10      // `<command> test`
11      // ...
12    }
13  )
14  .add(
15    'test start',
16    {
17      // Config
18    },
19    () => {
20      // `<command> test start`
21      // ...
22    }
23  )

Run as Command

The run function executes the command immediately using process.argv.

1import { App } from '@jill64/ts-cli'
2import process from 'node:process'
3
4new App(/* ... */).run(process.argv)

Export as API

1// index.js
2import { App } from '@jill64/ts-cli'
3
4export const command = new App(/* ... */).add(/* ... */).add(/* ... */)

1import { command } from 'index.js'
2
3// `example`
4command.execute({
5  args: {
6    arg1: 'value1',
7    arg2: 'value2',
8    arg3: 'value3'
9  },
10  optional: {
11    'optional-1': 'optional-value1',
12    'optional-2': 'optional-value2',
13    'optional-3': 'optional-value3'
14  },
15  // or
16  // rest: ['rest1', 'rest2', 'rest3'],
17  options: {
18    verbose: true,
19    host: 'example.com'
20  }
21})
22
23// `example test`
24command.invoke.test({
25  // ...
26})
27
28// `example test start`
29command.invoke['test start']({
30  // ...
31})

License

MIT