inferCliName

Generated reference page for the inferCliName function export.

• Import: @kjanat/dreamcli
• Export kind: function
• Declared in: src/core/config/package-json.ts
• Source link: packages/dreamcli/src/core/config/package-json.ts:203

Signatures

function inferCliName(pkg: PackageJsonData): string | undefined;

Members

Members

inferCliName

Infer the CLI binary name from package.json data.

Resolution order:

1. First key of bin object (e.g. {"mycli": "./dist/cli.js"} → "mycli")
2. Package name with scope stripped (e.g. "@scope/mycli" → "mycli")
3. undefined if neither exists

(pkg: PackageJsonData): string | undefined;

Examples

import { inferCliName } from '@kjanat/dreamcli';

inferCliName({ bin: { mycli: './dist/cli.js' } }); // 'mycli'
inferCliName({ name: '@scope/mycli' });             // 'mycli'
inferCliName({ name: 'mycli' });                    // 'mycli'
inferCliName({});                                   // undefined

See Also

• Examples overview
• Example Hover
• API overview
• @kjanat/dreamcli