API Reference

This page is rebuilt at docs build time from the public entrypoints declared in package.json. Use it to see the complete public surface grouped by subpath and export kind, then jump into the subpath-specific detail pages.

The reference surface is source-backed: symbol routes and example links are derived from src/** and examples/** during docs build.

• Public entrypoints: 9
• Public symbols indexed: 344
• Symbol pages rendered: 343

Choose an Import

Import	Use it for	Start here
@kjanat/dreamcli	schema builders, CLI assembly, parsing, resolution, errors, help	@kjanat/dreamcli
@kjanat/dreamcli/testkit	command tests, output capture, scripted prompts, test adapters	@kjanat/dreamcli/testkit
@kjanat/dreamcli/runtime	runtime detection, explicit adapters, runtime-only helpers	@kjanat/dreamcli/runtime
@kjanat/dreamcli/completion	shell completion script generators	@kjanat/dreamcli/completion
@kjanat/dreamcli/json-schema	definition documents, input JSON Schema, the meta-schema value	@kjanat/dreamcli/json-schema
@kjanat/dreamcli/config	config file and manifest discovery, custom config formats	@kjanat/dreamcli/config
@kjanat/dreamcli/prompt	the terminal prompt engine and prompt config resolution	@kjanat/dreamcli/prompt
@kjanat/dreamcli/schema	generated CLI definition meta-schema (export mapping differs by package target)	@kjanat/dreamcli/schema
@kjanat/dreamcli/version	the framework's own build version and revision	@kjanat/dreamcli/version

Generated Index

@kjanat/dreamcli

Source entrypoint: src/index.ts

@kjanat/dreamcli detailed page

Functions (28)

Symbol	Source
cli	src/core/cli/index.ts
command	src/core/schema/command.ts
createArgSchema	src/core/schema/arg.ts
createCLISchema	src/core/cli/index.ts
createCommandSchema	src/core/schema/command.ts
createFlagSchema	src/core/schema/flag.ts
createOutput	src/core/output/index.ts
formatHelp	src/core/help/index.ts
getFlagNegatedName	src/core/schema/flag.ts
group	src/core/schema/command.ts
includesBeforeSeparator	src/core/parse/index.ts
isCLIError	src/core/errors/index.ts
isMainModule	src/core/cli/index.ts
isParseError	src/core/errors/index.ts
isValidationError	src/core/errors/index.ts
middleware	src/core/schema/middleware.ts
osc8	src/core/help/ansi.ts
parse	src/core/parse/index.ts
plugin	src/core/cli/plugin.ts
readFlags	src/core/read-flags/index.ts
resolve	src/core/resolve/index.ts
resolveExampleCommand	src/core/schema/command.ts
resolvePromptConfig	src/core/prompt/index.ts
resolveRenderContext	src/core/cli/index.ts
stripBeforeSeparator	src/core/parse/index.ts
tokenize	src/core/parse/index.ts
visibleWidth	src/core/help/ansi.ts
wasExplicit	src/core/schema/provenance.ts

Classes (7)

Symbol	Source
ArgBuilder	src/core/schema/arg.ts
CLIBuilder	src/core/cli/index.ts
CLIError	src/core/errors/index.ts
CommandBuilder	src/core/schema/command.ts
FlagBuilder	src/core/schema/flag.ts
ParseError	src/core/errors/index.ts
ValidationError	src/core/errors/index.ts

Constants (7)

Symbol	Source
arg	src/core/schema/arg.ts
DEFINITION_SCHEMA_URL	src/core/json-schema/constants.ts
DEFINITION_SCHEMA_VERSION	src/core/json-schema/constants.ts
DUPLICATE_KEYS	src/core/schema/cardinality.ts
flag	src/core/schema/flag.ts
SHELLS	src/core/completion/shell.ts
SPLIT_FORMATS	src/core/schema/cardinality.ts

Interfaces (113)

Symbol	Source
ActionParams	src/core/schema/command.ts
ArgConfig	src/core/schema/arg.ts
ArgDefinitionBase	src/core/schema/arg.ts
ArgDefinitionByKind	src/core/schema/arg.ts
ArgFactory	src/core/schema/arg.ts
ArgSchema	src/core/schema/arg.ts
ArrayFlagDefinition	src/core/schema/flag.ts
BeforeParseParams	src/core/cli/plugin.ts
BooleanArgDefinition	src/core/schema/arg.ts
BooleanFlagDefinition	src/core/schema/flag.ts
Builtins	src/core/cli/builtins.ts
BuiltinsConfig	src/core/cli/builtins.ts
CLIDefinition	src/core/cli/index.ts
CLIErrorJSON	src/core/errors/index.ts
CLIErrorOptions	src/core/errors/index.ts
CLIExecuteOptions	src/core/cli/index.ts
CLIOptions	src/core/cli/index.ts
CLIPlugin	src/core/cli/plugin.ts
CLIPluginHooks	src/core/cli/plugin.ts
CLIRunOptions	src/core/cli/index.ts
CLISchema	src/core/cli/index.ts
Colors	node_modules/ansispeck/dist/whitespace.d.ts
CommandArgEntry	src/core/schema/command.ts
CommandArgEntryDefinition	src/core/schema/command.ts
CommandDefinition	src/core/schema/command.ts
CommandExample	src/core/schema/command.ts
CommandMeta	src/core/schema/command.ts
CommandSchema	src/core/schema/command.ts
CompletionOptions	src/core/completion/shells/shared.ts
CompletionRegistrationOptions	src/core/cli/index.ts
CompletionsFlagConfig	src/core/cli/index.ts
ConfigDiscoveryOptions	src/core/config/index.ts
ConfigFound	src/core/config/index.ts
ConfigNotFound	src/core/config/index.ts
ConfigSearchPathOptions	src/core/config/index.ts
ConfigSettings	src/core/cli/index.ts
ConfigSettingsDefinition	src/core/cli/index.ts
ConfirmPromptConfig	src/core/schema/prompt.ts
CountFlagDefinition	src/core/schema/flag.ts
CustomArgDefinition	src/core/schema/arg.ts
CustomFlagDefinition	src/core/schema/flag.ts
DateFlagOptions	src/core/schema/value-parsers.ts
DefaultCommandOptions	src/core/cli/index.ts
DefaultValueOptions	src/core/schema/flag.ts
DeprecationWarning	src/core/resolve/contracts.ts
EnumArgDefinition	src/core/schema/arg.ts
EnumFlagDefinition	src/core/schema/flag.ts
ExampleMeta	src/core/schema/command.ts
FlagConfig	src/core/schema/flag.ts
FlagDefinitionBase	src/core/schema/flag.ts
FlagDefinitionByKind	src/core/schema/flag.ts
FlagFactory	src/core/schema/flag.ts
FlagNegation	src/core/schema/flag.ts
FlagSchema	src/core/schema/flag.ts
FormatLoader	src/core/config/index.ts
HelpConfig	src/core/cli/index.ts
HelpLinks	src/core/cli/help-links.ts
HelpOptions	src/core/help/index.ts
HelpTheme	src/core/help/theme.ts
InputPromptConfig	src/core/schema/prompt.ts
InputSources	src/core/schema/provenance.ts
InteractiveParams	src/core/schema/command.ts
JsonSchemaOptions	src/core/json-schema/index.ts
KeyValueArgDefinition	src/core/schema/arg.ts
KeyValueFlagDefinition	src/core/schema/flag.ts
ManifestDiscoveryOptions	src/core/config/package-json.ts
ManifestSettings	src/core/cli/index.ts
MiddlewareParams	src/core/schema/middleware.ts
MultiselectPromptConfig	src/core/schema/prompt.ts
NumberArgDefinition	src/core/schema/arg.ts
NumberConstraints	src/core/schema/number-constraints.ts
NumberFlagDefinition	src/core/schema/flag.ts
Out	src/core/schema/command.ts
OutputOptions	src/core/output/index.ts
PackageJsonData	src/core/config/package-json.ts
PackageRepository	src/core/config/package-json.ts
PackageRepositoryUrlOptions	src/core/config/repository-url.ts
ParseErrorOptions	src/core/errors/index.ts
ParseOptions	src/core/parse/index.ts
ParseResult	src/core/parse/index.ts
PathChecks	src/core/schema/value-parsers.ts
PluginCommandContext	src/core/cli/plugin.ts
ProgressHandle	src/core/schema/activity.ts
ProgressOptions	src/core/schema/activity.ts
PromptConfigBase	src/core/schema/prompt.ts
PromptEngine	src/core/prompt/index.ts
ReadFlagsOptions	src/core/read-flags/index.ts
RenderContext	src/core/cli/index.ts
RenderContextOptions	src/core/cli/index.ts
ResolutionProvenanceRecord	src/core/resolve/contracts.ts
ResolvedCommandParams	src/core/cli/plugin.ts
ResolvedManifestSettings	src/core/cli/index.ts
ResolvedMultiselectPromptConfig	src/core/prompt/index.ts
ResolvedSelectPromptConfig	src/core/prompt/index.ts
ResolveOptions	src/core/resolve/contracts.ts
ResolveResult	src/core/resolve/contracts.ts
RunResult	src/core/schema/run.ts
SelectChoice	src/core/schema/prompt.ts
SelectPromptConfig	src/core/schema/prompt.ts
SourceSplitBinding	src/core/schema/cardinality.ts
SpinnerHandle	src/core/schema/activity.ts
SpinnerOptions	src/core/schema/activity.ts
SplitBinding	src/core/schema/cardinality.ts
SplitOptions	src/core/schema/cardinality.ts
StandardSchemaV1	src/core/schema/standard.ts
StdinBinding	src/core/schema/stdin.ts
StdinOptions	src/core/schema/stdin.ts
StringArgDefinition	src/core/schema/arg.ts
StringConstraints	src/core/schema/string-constraints.ts
StringFlagDefinition	src/core/schema/flag.ts
TableColumn	src/core/schema/activity.ts
UrlFlagOptions	src/core/schema/value-parsers.ts
ValidationErrorOptions	src/core/errors/index.ts

Types (101)

Symbol	Source
ActionHandler	src/core/schema/command.ts
ActivityEvent	src/core/schema/activity.ts
ArgDefaultValue	src/core/schema/arg.ts
ArgDefinition	src/core/schema/arg.ts
ArgDefinitionFragmentV1	src/core/json-schema/index.ts
ArgDefinitionOverrides	src/core/schema/arg.ts
ArgElementFragmentV1	src/core/json-schema/index.ts
ArgKind	src/core/schema/arg.ts
ArgParseFn	src/core/schema/arg.ts
ArgPresence	src/core/schema/arg.ts
BuiltinMode	src/core/cli/builtins.ts
BuiltinName	src/core/cli/builtins.ts
CommandDefinitionDocument	src/core/json-schema/index.ts
CommandDefinitionDocumentV1	src/core/json-schema/index.ts
CommandDefinitionFragmentV1	src/core/json-schema/index.ts
ConfigAdapter	src/core/config/index.ts
ConfigDiscoveryResult	src/core/config/index.ts
DefinitionDocument	src/core/json-schema/index.ts
DefinitionDocumentV1	src/core/json-schema/index.ts
DeriveHandler	src/core/schema/command.ts
DeriveParams	src/core/schema/command.ts
DuplicateKeys	src/core/schema/cardinality.ts
DuplicatePolicy	src/core/schema/flag.ts
ErrorCode	src/core/errors/index.ts
ExampleCommand	src/core/schema/command.ts
ExampleDefinitionFragmentV1	src/core/json-schema/index.ts
Fallback	src/core/schema/activity.ts
FlagDefinition	src/core/schema/flag.ts
FlagDefinitionFragmentV1	src/core/json-schema/index.ts
FlagDefinitionOverrides	src/core/schema/flag.ts
FlagElementFragmentV1	src/core/json-schema/index.ts
FlagKind	src/core/schema/flag.ts
FlagMap	src/core/read-flags/index.ts
FlagNegationFragmentV1	src/core/json-schema/index.ts
FlagParseFn	src/core/schema/flag.ts
FlagPathChecksFragmentV1	src/core/json-schema/index.ts
FlagPresence	src/core/schema/flag.ts
FlagStringConstraintsFragmentV1	src/core/json-schema/index.ts
HelpDescription	src/core/help/theme.ts
HelpThemeFactory	src/core/help/theme.ts
InferArg	src/core/schema/arg.ts
InferArgs	src/core/schema/arg.ts
InferFlag	src/core/schema/flag.ts
InferFlags	src/core/schema/flag.ts
InferNameOption	src/core/cli/index.ts
InferStandardInput	src/core/schema/standard.ts
InferStandardOutput	src/core/schema/standard.ts
InputSchemaBranch	src/core/json-schema/index.ts
InputSchemaDocument	src/core/json-schema/index.ts
InputSchemaProperty	src/core/json-schema/index.ts
InteractiveResolver	src/core/schema/command.ts
InteractiveResult	src/core/schema/command.ts
Middleware	src/core/schema/middleware.ts
MiddlewareHandler	src/core/schema/middleware.ts
NumberConstraintViolation	src/core/schema/number-constraints.ts
PackageJsonAdapter	src/core/config/package-json.ts
ParseErrorCode	src/core/errors/index.ts
PathFlagOptions	src/core/schema/value-parsers.ts
PromptChoiceFragmentV1	src/core/json-schema/index.ts
PromptConfig	src/core/schema/prompt.ts
PromptDefinitionFragmentV1	src/core/json-schema/index.ts
PromptKind	src/core/schema/prompt.ts
PromptResult	src/core/schema/prompt.ts
ReadFn	src/core/prompt/index.ts
ResolutionProvenance	src/core/schema/provenance.ts
ResolvedArgValue	src/core/schema/arg.ts
ResolvedPromptConfig	src/core/prompt/index.ts
ResolvedValue	src/core/schema/flag.ts
Shell	src/core/completion/shell.ts
SourcesOf	src/core/schema/provenance.ts
SourceSplitFragmentV1	src/core/json-schema/index.ts
SplitFormat	src/core/schema/cardinality.ts
SplitPolicy	src/core/schema/cardinality.ts
SplitPolicyFragmentV1	src/core/json-schema/index.ts
SplitSetting	src/core/schema/cardinality.ts
StandardSchemaV1FailureResult	src/core/schema/standard.ts
StandardSchemaV1Issue	src/core/schema/standard.ts
StandardSchemaV1Options	src/core/schema/standard.ts
StandardSchemaV1PathSegment	src/core/schema/standard.ts
StandardSchemaV1Props	src/core/schema/standard.ts
StandardSchemaV1Result	src/core/schema/standard.ts
StandardSchemaV1SuccessResult	src/core/schema/standard.ts
StandardSchemaV1Types	src/core/schema/standard.ts
StdinBindingFragmentV1	src/core/json-schema/index.ts
StdinConsume	src/core/schema/stdin.ts
StdinWhen	src/core/schema/stdin.ts
StringArgElementConfig	src/core/schema/arg.ts
StringConstraintViolation	src/core/schema/string-constraints.ts
StringElementConfig	src/core/schema/flag.ts
TableFormat	src/core/schema/activity.ts
TableOptions	src/core/schema/activity.ts
TableStream	src/core/schema/activity.ts
Token	src/core/parse/index.ts
ValidationErrorCode	src/core/errors/index.ts
Verbosity	src/core/output/contracts.ts
WithArgPresence	src/core/schema/arg.ts
WithoutArgElementEligibility	src/core/schema/arg.ts
WithoutElementEligibility	src/core/schema/flag.ts
WithPresence	src/core/schema/flag.ts
WithVariadic	src/core/schema/arg.ts
WriteFn	src/core/output/writer.ts

@kjanat/dreamcli/completion

Source entrypoint: src/completion.ts

@kjanat/dreamcli/completion detailed page

Functions (5)

Symbol	Source
generateBashCompletion	src/core/completion/shells/bash.ts
generateCompletion	src/core/completion/index.ts
generateFishCompletion	src/core/completion/shells/fish.ts
generatePowerShellCompletion	src/core/completion/shells/powershell.ts
generateZshCompletion	src/core/completion/shells/zsh.ts

Constants (1)

Symbol	Source
SHELLS	src/core/completion/shell.ts

Interfaces (1)

Symbol	Source
CompletionOptions	src/core/completion/shells/shared.ts

Types (1)

Symbol	Source
Shell	src/core/completion/shell.ts

@kjanat/dreamcli/config

Source entrypoint: src/config.ts

@kjanat/dreamcli/config detailed page

Functions (6)

Symbol	Source
buildConfigSearchPaths	src/core/config/index.ts
configFormat	src/core/config/index.ts
discoverConfig	src/core/config/index.ts
discoverManifest	src/core/config/package-json.ts
inferCliName	src/core/config/package-json.ts
packageRepositoryUrl	src/core/config/repository-url.ts

Interfaces (9)

Symbol	Source
ConfigDiscoveryOptions	src/core/config/index.ts
ConfigFound	src/core/config/index.ts
ConfigNotFound	src/core/config/index.ts
ConfigSearchPathOptions	src/core/config/index.ts
FormatLoader	src/core/config/index.ts
ManifestDiscoveryOptions	src/core/config/package-json.ts
PackageJsonData	src/core/config/package-json.ts
PackageRepository	src/core/config/package-json.ts
PackageRepositoryUrlOptions	src/core/config/repository-url.ts

Types (3)

Symbol	Source
ConfigAdapter	src/core/config/index.ts
ConfigDiscoveryResult	src/core/config/index.ts
PackageJsonAdapter	src/core/config/package-json.ts

@kjanat/dreamcli/json-schema

Source entrypoint: src/json-schema.ts

@kjanat/dreamcli/json-schema detailed page

Functions (3)

Symbol	Source
generateCommandSchema	src/core/json-schema/index.ts
generateInputSchema	src/core/json-schema/index.ts
generateSchema	src/core/json-schema/index.ts

Constants (3)

Symbol	Source
DEFINITION_SCHEMA_URL	src/core/json-schema/constants.ts
DEFINITION_SCHEMA_VERSION	src/core/json-schema/constants.ts
definitionMetaSchema	src/core/json-schema/index.ts

Interfaces (1)

Symbol	Source
JsonSchemaOptions	src/core/json-schema/index.ts

Types (21)

Symbol	Source
ArgDefinitionFragmentV1	src/core/json-schema/index.ts
ArgElementFragmentV1	src/core/json-schema/index.ts
CommandDefinitionDocument	src/core/json-schema/index.ts
CommandDefinitionDocumentV1	src/core/json-schema/index.ts
CommandDefinitionFragmentV1	src/core/json-schema/index.ts
DefinitionDocument	src/core/json-schema/index.ts
DefinitionDocumentV1	src/core/json-schema/index.ts
ExampleDefinitionFragmentV1	src/core/json-schema/index.ts
FlagDefinitionFragmentV1	src/core/json-schema/index.ts
FlagElementFragmentV1	src/core/json-schema/index.ts
FlagNegationFragmentV1	src/core/json-schema/index.ts
FlagPathChecksFragmentV1	src/core/json-schema/index.ts
FlagStringConstraintsFragmentV1	src/core/json-schema/index.ts
InputSchemaBranch	src/core/json-schema/index.ts
InputSchemaDocument	src/core/json-schema/index.ts
InputSchemaProperty	src/core/json-schema/index.ts
PromptChoiceFragmentV1	src/core/json-schema/index.ts
PromptDefinitionFragmentV1	src/core/json-schema/index.ts
SourceSplitFragmentV1	src/core/json-schema/index.ts
SplitPolicyFragmentV1	src/core/json-schema/index.ts
StdinBindingFragmentV1	src/core/json-schema/index.ts

@kjanat/dreamcli/prompt

Source entrypoint: src/prompt.ts

@kjanat/dreamcli/prompt detailed page

Functions (2)

Symbol	Source
createTerminalPrompter	src/core/prompt/terminal.ts
resolvePromptConfig	src/core/prompt/index.ts

Interfaces (3)

Symbol	Source
PromptEngine	src/core/prompt/index.ts
ResolvedMultiselectPromptConfig	src/core/prompt/index.ts
ResolvedSelectPromptConfig	src/core/prompt/index.ts

Types (2)

Symbol	Source
ReadFn	src/core/prompt/index.ts
ResolvedPromptConfig	src/core/prompt/index.ts

@kjanat/dreamcli/runtime

Source entrypoint: src/runtime.ts

@kjanat/dreamcli/runtime detailed page

Functions (4)

Symbol	Source
createAdapter	src/runtime/auto.ts
createDenoAdapter	src/runtime/deno.ts
createNodeAdapter	src/runtime/node.ts
detectRuntime	src/runtime/detect.ts

Classes (1)

Symbol	Source
ExitError	src/runtime/adapter.ts

Constants (1)

Symbol	Source
RUNTIMES	src/runtime/detect.ts

Interfaces (5)

Symbol	Source
DenoNamespace	src/runtime/deno.ts
GlobalForDetect	src/runtime/detect.ts
NodeProcess	src/runtime/node.ts
RuntimeAdapter	src/runtime/adapter.ts
TerminalSize	src/runtime/adapter.ts

Types (1)

Symbol	Source
Runtime	src/runtime/detect.ts

@kjanat/dreamcli/schema

Source entrypoint: dreamcli.schema.json

@kjanat/dreamcli/schema detailed page

Assets (1)

Symbol	Source
schema	dreamcli.schema.json

@kjanat/dreamcli/testkit

Source entrypoint: src/testkit.ts

@kjanat/dreamcli/testkit detailed page

Functions (4)

Symbol	Source
createCaptureOutput	src/core/output/index.ts
createTestAdapter	src/runtime/adapter.ts
createTestPrompter	src/core/prompt/test-prompter.ts
runCommand	src/core/testkit/index.ts

Constants (1)

Symbol	Source
PROMPT_CANCEL	src/core/prompt/test-prompter.ts

Interfaces (6)

Symbol	Source
CapturedOutput	src/core/output/index.ts
RunCommandOptions	src/core/testkit/index.ts
RunOptions	src/core/schema/run.ts
RunResult	src/core/schema/run.ts
TestAdapterOptions	src/runtime/adapter.ts
TestPrompterOptions	src/core/prompt/test-prompter.ts

Types (1)

Symbol	Source
TestAnswer	src/core/prompt/test-prompter.ts

@kjanat/dreamcli/version

Source entrypoint: src/version.ts

@kjanat/dreamcli/version detailed page

Constants (2)

Symbol	Source
DREAMCLI_REVISION	src/version.ts
DREAMCLI_VERSION	src/version.ts

Related Guides

• CLI Semantics — exact parser, resolver, and root-surface behavior
• Examples — source-backed examples with Twoslash hover and related symbol links
• Planner Contract — internal dispatch outcomes and matched-command handoff
• Resolver Contract — internal precedence, diagnostics, and resolved-value handoff
• Output Contract — internal routing, activity mode, and cleanup policy facts
• Testing Commands — higher-level testkit usage patterns
• Runtime Support — runtime packages and adapter expectations
• Changelog — release history mirrored inside the docs site
• Support Matrix — audited support status, evidence, and deferred work

Detailed Reference

• @kjanat/dreamcli — main package API
• @kjanat/dreamcli/testkit — testing utilities
• @kjanat/dreamcli/runtime — runtime adapters
• @kjanat/dreamcli/completion — completion script generators
• @kjanat/dreamcli/json-schema — definition and input schema generation
• @kjanat/dreamcli/config — config and manifest discovery
• @kjanat/dreamcli/prompt — prompt engines
• @kjanat/dreamcli/schema — the definition meta-schema document
• @kjanat/dreamcli/version — framework build constants