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: src/core/config/package-json.ts:592

Signatures

function inferCliName(pkg: PackageJsonData, options: { stripScope?: boolean; }): string | undefined;

Parameter	Type	Description
pkg	PackageJsonData	Parsed manifest metadata.
options	{ stripScope?: boolean; } = {}	stripScope (default true): strip a leading @scope/ from the name fallback.

Members

Members

inferCliName

Infer the CLI binary name from manifest data.

Resolution order:

1. First key of bin object (e.g. {"mycli": "./dist/cli.js"} → "mycli")
2. Package name, scope stripped by default (e.g. "@scope/mycli" → "mycli"); pass { stripScope: false } to keep the full scoped name
3. undefined if neither exists

Note: bin keys are never scoped, so stripScope only affects the name fallback (relevant for deno.json / jsr.json, which have no bin field).

(pkg: PackageJsonData, options: { stripScope?: boolean; }): string | undefined;

Examples

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

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

See Also

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