# tj/commander.js

<!-- source: class-argument.md -->

# Argument

**Kind:** Class

**Source:** `/tmp/atloria-clones/commander.js-1783366838315/lib/argument.js` (line 3)

<!-- source: function-humanreadableargname.md -->

# humanReadableArgName

**Kind:** Function

**Source:** `/tmp/atloria-clones/commander.js-1783366838315/lib/argument.js` (line 143)

Takes an argument and returns its human readable equivalent for help usage.

<!-- source: system-overview.md -->

# tj/commander.js

## Overview

Auto-generated technical documentation for **tj/commander.js** — 202 entities (181 doc comments, 10 markdown docs, 7 classs, 4 functions).

## Key Components

_The most-referenced entities — start here._

- **Problem** (doc comment) — referenced 1×
- **Solution** (doc comment) — referenced 1×
- **ChangeLog** (doc comment) — referenced 1×
- **Deprecated** (doc comment) — referenced 1×
- **RegExp .option() parameter** (doc comment) — referenced 1×
- **noHelp** (doc comment) — referenced 1×
- **Callback to .help() and .outputHelp()** (doc comment) — referenced 1×
- **.on('--help')** (doc comment) — referenced 1×
- **.on('command:*')** (doc comment) — referenced 1×
- **.command('*')** (doc comment) — referenced 1×

<!-- source: class-command.md -->

# Command

**Kind:** Class

**Source:** `/tmp/atloria-clones/commander.js-1783366838315/lib/command.js` (line 14)

<!-- source: function-usecolor.md -->

# useColor

**Kind:** Function

**Source:** `/tmp/atloria-clones/commander.js-1783366838315/lib/command.js` (line 2768)

Exported for using from tests, not otherwise used outside this file.

<!-- source: class-commandererror.md -->

# CommanderError

**Kind:** Class

**Source:** `/tmp/atloria-clones/commander.js-1783366838315/lib/error.js` (line 4)

CommanderError class

<!-- source: function-suggestsimilar.md -->

# suggestSimilar

**Kind:** Function

**Source:** `/tmp/atloria-clones/commander.js-1783366838315/lib/suggestSimilar.js` (line 56)

Find close matches, restricted to same number of edits.

<!-- source: function-createtestcommand.md -->

# createTestCommand

**Kind:** Function

**Source:** `/tmp/atloria-clones/commander.js-1783366838315/tests/testHelpers.js` (line 12)

Create a Command configured for using in tests.

Throws exceptions instead of calling process.exit (.exitOverride())
and output suppressed.

<!-- source: class-invalidargumenterror.md -->

# InvalidArgumentError

**Kind:** Class

**Source:** `/tmp/atloria-clones/commander.js-1783366838315/lib/error.js` (line 25)

InvalidArgumentError class

<!-- source: class-help.md -->

# Help

**Kind:** Class

**Source:** `/tmp/atloria-clones/commander.js-1783366838315/lib/help.js` (line 13)

TypeScript import types for JSDoc, used by Visual Studio Code IntelliSense and `npm run typescript-checkJS`
https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html#import-types

<!-- source: class-option.md -->

# Option

**Kind:** Class

**Source:** `/tmp/atloria-clones/commander.js-1783366838315/lib/option.js` (line 3)

<!-- source: class-dualoptions.md -->

# DualOptions

**Kind:** Class

**Source:** `/tmp/atloria-clones/commander.js-1783366838315/lib/option.js` (line 268)

This class is to make it easier to work with dual options, without changing the existing
implementation. We support separate dual options for separate positive and negative options,
like `--build` and `--no-build`, which share a single option value. This works nicely for some
use cases, but is tricky for others where we want separate behaviours despite
the single shared option value.