# burgee/commander

> burgee/commander is a drop-in for commander: the same API, documented by commander itself. Every name it exports, and where its reference lives.

Source: https://burgee.interlace.tools/docs/api/commander

<!-- Generated by scripts/api-reference.ts from the built dist/*.d.ts and burgee/src/compat.ts. Do not edit; run `npx tsx scripts/api-reference.ts`. -->

`burgee/commander` is a drop-in for `commander`, graded by the incumbent's own test suite. Its API is the incumbent's, so its reference is the incumbent's own documentation.

- **Reference:** [commander 15.0.0](https://www.npmjs.com/package/commander/v/15.0.0), the release that suite is run at.
- **How closely it matches:** [Compatibility](/docs/compatibility), that suite's result in CI, with every case left out of the gate and the reason.
- **Side by side:** [burgee vs commander](/docs/vs/commander).
- **Moving a program over:** [`burgee migrate`](/docs/migrate) rewrites `'commander'` to `'burgee/commander'` across a project.

## Exports

Every name `burgee/commander` exports, as the built declarations state them. Signatures and behaviour are commander's.

| Export | Kind |
| :-- | :-- |
| `humanReadableArgName` | function |
| `useColor` | function |
| `Argument` | class |
| `Command` | class |
| `CommanderError` | class |
| `DualOptions` | class |
| `Help` | class |
| `InvalidArgumentError` | class |
| `InvalidOptionArgumentError` | class |
| `Option` | class |
| `createArgument` | const |
| `createCommand` | const |
| `createOption` | const |
| `program` | const |
| `BurgeeParseOptions` | interface |
| `CommandOptions` | interface |
| `ErrorOptions` | interface |
| `ExecutableCommandOptions` | interface |
| `HelpContext` | interface |
| `OutputContext` | interface |
| `ParseOptions` | interface |
| `ParseOptionsResult` | interface |
| `AddHelpTextContext` | type |
| `AddHelpTextPosition` | type |
| `HelpConfiguration` | type |
| `HookEvent` | type |
| `HookListener` | type |
| `OptionValues` | type |
| `OptionValueSource` | type |
| `OutputConfiguration` | type |