# Commander

A simple library for building CLI with sub-commands in Node.js.

## Install

```sh
npm install @xieyuheng/commander
```

## Usage

```typescript
import { Commander, type Command } from "@xieyuheng/commander"

export const addCommand: Command = {
  name: "add",
  description: "add two numbers",

  help(commander) {
    return [
      `The add command add two numbers and print the result.`,
      ``,
      `  ${commander.name} ${this.name} 2 2`,
    ].join("\n")
  },

  async run(commander) {
    const x = Number(commander.args[0])
    const y = Number(commander.args[1])
    console.log(x + y)
  },
}

async function main() {
  const commander = new Commander()
  commander.use(addCommand)
  await commander.run(process.argv)
}

main()
```

## Development

```sh
npm install     # Install dependencies
npm run build   # Compile `src/` to `lib/`
npm run test    # Run test
```

## Contributions

To make a contribution, fork this project and create a pull request.

Please read the [STYLE-GUIDE.md](STYLE-GUIDE.md) before you change the code.

Remember to add yourself to [AUTHORS](AUTHORS).
Your line belongs to you, you can write a little
introduction to yourself but not too long.

## License

[GPLv3](LICENSE)