cli

CLI

New scripts parse arguments with commander through @commander-js/extra-typings, which infers each option's and argument's type from its flag string. Scripts still on cleye migrate to commander over time.

Import Command, Option, and the error classes from @commander-js/extra-typings. Importing them from commander drops the inference and types every option as any.

Basic Usage

#!/usr/bin/env bun

import { Command, Option } from "@commander-js/extra-typings";

export const program = new Command("scan")
  .description("Scan repository prose for AI writing tropes.")
  .argument("<path>", "directory to scan")
  .option("-o, --output <file>", "output path")
  .addOption(new Option("--format <format>", "output format").choices(["text", "json"]).default("text"))
  .option("--dry-run", "report without writing")
  .action((path, options) => {
    console.log(path); // string
    console.log(options.output); // string | undefined
    console.log(options.format); // "text" | "json"
    console.log(options.dryRun); // true | undefined
  });

if (import.meta.main) {
  await program.parseAsync();
}

The action receives each declared argument in order, then the options object, then the command. Reading an undeclared key such as options.outptu is a type error.

parseAsync handles --help and -h, and awaits an async action. A missing argument, an unknown option, an excess positional, or a value outside choices prints an error and exits 1.

Options

A default or requiredOption drops undefined from the type. A kebab-case flag (--dry-run) arrives as a camelCase key (dryRun). An enum needs addOption with new Option(...).choices([...]), which types the value as the union.