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: 4
• Public symbols indexed: 160
• Symbol pages rendered: 159

Choose an Import

Import	Use it for	Start here
@kjanat/dreamcli	schema builders, CLI assembly, parsing, resolution, errors, completions, schema export	@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/schema	generated CLI definition meta-schema JSON	schema asset only

Generated Index

@kjanat/dreamcli

Source entrypoint: src/index.ts

@kjanat/dreamcli detailed page

Functions (29)

Symbol	Source
buildConfigSearchPaths	src/core/config/index.ts
cli	src/core/cli/index.ts
command	src/core/schema/command.ts
configFormat	src/core/config/index.ts
createArgSchema	src/core/schema/arg.ts
createOutput	src/core/output/index.ts
createSchema	src/core/schema/flag.ts
createTerminalPrompter	src/core/prompt/index.ts
discoverConfig	src/core/config/index.ts
discoverPackageJson	src/core/config/package-json.ts
formatHelp	src/core/help/index.ts
generateBashCompletion	src/core/completion/shells/bash.ts
generateCompletion	src/core/completion/index.ts
generateFishCompletion	src/core/completion/shells/fish.ts
generateInputSchema	src/core/json-schema/index.ts
generatePowerShellCompletion	src/core/completion/shells/powershell.ts
generateSchema	src/core/json-schema/index.ts
generateZshCompletion	src/core/completion/shells/zsh.ts
group	src/core/schema/command.ts
inferCliName	src/core/config/package-json.ts
isCLIError	src/core/errors/index.ts
isParseError	src/core/errors/index.ts
isValidationError	src/core/errors/index.ts
middleware	src/core/schema/middleware.ts
parse	src/core/parse/index.ts
plugin	src/core/cli/plugin.ts
resolve	src/core/resolve/index.ts
resolvePromptConfig	src/core/prompt/index.ts
tokenize	src/core/parse/index.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 (4)

Symbol	Source
arg	src/core/schema/arg.ts
definitionMetaSchema	src/core/json-schema/index.ts
flag	src/core/schema/flag.ts
SHELLS	src/core/completion/index.ts

Interfaces (57)

Symbol	Source
ActionParams	src/core/schema/command.ts
ArgConfig	src/core/schema/arg.ts
ArgFactory	src/core/schema/arg.ts
ArgSchema	src/core/schema/arg.ts
BeforeParseParams	src/core/cli/plugin.ts
CLIErrorJSON	src/core/errors/index.ts
CLIErrorOptions	src/core/errors/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
CommandArgEntry	src/core/schema/command.ts
CommandConfig	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
ConfigDiscoveryOptions	src/core/config/index.ts
ConfigFound	src/core/config/index.ts
ConfigNotFound	src/core/config/index.ts
ConfigSettings	src/core/cli/index.ts
ConfirmPromptConfig	src/core/schema/prompt.ts
DeprecationWarning	src/core/resolve/contracts.ts
FlagConfig	src/core/schema/flag.ts
FlagFactory	src/core/schema/flag.ts
FlagSchema	src/core/schema/flag.ts
FormatLoader	src/core/config/index.ts
HelpOptions	src/core/help/index.ts
InputPromptConfig	src/core/schema/prompt.ts
InteractiveParams	src/core/schema/command.ts
JsonSchemaOptions	src/core/json-schema/index.ts
MiddlewareParams	src/core/schema/middleware.ts
MultiselectPromptConfig	src/core/schema/prompt.ts
Out	src/core/schema/command.ts
OutputOptions	src/core/output/index.ts
PackageJsonData	src/core/config/package-json.ts
PackageJsonSettings	src/core/cli/index.ts
ParseErrorOptions	src/core/errors/index.ts
ParseResult	src/core/parse/index.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
ResolvedCommandParams	src/core/cli/plugin.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
SpinnerHandle	src/core/schema/activity.ts
SpinnerOptions	src/core/schema/activity.ts
TableColumn	src/core/schema/activity.ts
ValidationErrorOptions	src/core/errors/index.ts

Types (42)

Symbol	Source
ActionHandler	src/core/schema/command.ts
ActivityEvent	src/core/schema/activity.ts
ArgKind	src/core/schema/arg.ts
ArgParseFn	src/core/schema/arg.ts
ArgPresence	src/core/schema/arg.ts
ConfigAdapter	src/core/config/index.ts
ConfigDiscoveryResult	src/core/config/index.ts
DeriveHandler	src/core/schema/command.ts
DeriveParams	src/core/schema/command.ts
ErrorCode	src/core/errors/index.ts
Fallback	src/core/schema/activity.ts
FlagKind	src/core/schema/flag.ts
FlagParseFn	src/core/schema/flag.ts
FlagPresence	src/core/schema/flag.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
InteractiveResolver	src/core/schema/command.ts
InteractiveResult	src/core/schema/command.ts
Middleware	src/core/schema/middleware.ts
MiddlewareHandler	src/core/schema/middleware.ts
PackageJsonAdapter	src/core/config/package-json.ts
ParseErrorCode	src/core/errors/index.ts
PromptConfig	src/core/schema/prompt.ts
PromptKind	src/core/schema/prompt.ts
PromptResult	src/core/schema/prompt.ts
ReadFn	src/core/prompt/index.ts
ResolvedArgValue	src/core/schema/arg.ts
ResolvedPromptConfig	src/core/prompt/index.ts
ResolvedValue	src/core/schema/flag.ts
Shell	src/core/completion/index.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
WithPresence	src/core/schema/flag.ts
WithVariadic	src/core/schema/arg.ts
WriteFn	src/core/output/writer.ts

@kjanat/dreamcli/runtime

Source entrypoint: src/runtime.ts

@kjanat/dreamcli/runtime detailed page

Functions (5)

Symbol	Source
createAdapter	src/runtime/auto.ts
createBunAdapter	src/runtime/bun.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 (1)

Symbol	Source
RuntimeAdapter	src/runtime/adapter.ts

Types (1)

Symbol	Source
Runtime	src/runtime/detect.ts

@kjanat/dreamcli/schema

Source entrypoint: dreamcli.schema.json

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/index.ts
runCommand	src/core/testkit/index.ts

Constants (1)

Symbol	Source
PROMPT_CANCEL	src/core/prompt/index.ts

Interfaces (5)

Symbol	Source
CapturedOutput	src/core/output/index.ts
RunOptions	src/core/schema/run.ts
RunResult	src/core/schema/run.ts
TestAdapterOptions	src/runtime/adapter.ts
TestPrompterOptions	src/core/prompt/index.ts

Types (1)

Symbol	Source
TestAnswer	src/core/prompt/index.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