Skip to content

PackageJsonSettings

Package.json auto-discovery settings.

Stored in CLISchema and consumed by CLIBuilder.run() to call discoverPackageJson before dispatching to a command.

Signatures

ts
interface PackageJsonSettings {}

Members

Properties

data

Pre-loaded data; skips filesystem discovery, uses values verbatim.

ts
data: PackageJsonData | undefined;

from

Explicit filesystem anchor for discovery; overrides adapter.cwd.

Resolved to a string path before storage. When set, discoverPackageJson walks up from here instead of the runtime cwd. Required for installable CLIs whose version should reflect THEIR OWN package, not the consumer's working directory.

ts
from: string | undefined;

inferName

Infer CLI name from package.json bin keys or name field.

When true, the discovered name replaces the cli(name) value. Explicit .version()/.description() calls still take precedence over discovered values.

ts
inferName: boolean;

See Also

Released under the MIT License.