Skip to content
Convoker
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Home
Guides
Quick start
Argument parsing
Logging
Prompting
API reference
@convoker/core
Namespaces
i
classes
InputValidationError
Option
Positional
functions
argument
convert
option
positional
validate
interfaces
Input
StandardSchemaV1
namespaces
StandardSchemaV1
interfaces
FailureResult
Issue
PathSegment
Props
SuccessResult
Types
type-aliases
InferInput
InferOutput
Result
type-aliases
BasicKind
InferEntry
InferInput
Kind
TypeOf
parsers
classes
UnixParserError
functions
bsd
gnu
positional
unix
verbose
windows
interfaces
Parser
ParseResult
UnixPreset
Classes
Command
ConvokerError
HelpAskedError
MissingRequiredArgumentError
MissingRequiredOptionError
TooManyArgumentsError
UnknownOptionError
Interfaces
CommandAlias
InputMapEntry
ValidatedParseResult
Type Aliases
ActionFn
Builder
ErrorFn
MiddlewareFn
@convoker/input
Namespaces
StandardSchemaV1
interfaces
FailureResult
Issue
PathSegment
Props
SuccessResult
Types
type-aliases
InferInput
InferOutput
Result
Classes
InputValidationError
Option
Positional
Interfaces
Input
StandardSchemaV1
Type Aliases
BasicKind
InferEntry
InferInput
Kind
TypeOf
Functions
argument
convert
option
positional
validate
@convoker/log
Classes
WriteError
Interfaces
Config
Variables
DEFAULT_CONFIG
Functions
error
fatal
info
setConfig
trace
warn
@convoker/prompt
Classes
PromptValidationError
Interfaces
ConfirmOpts
CoreOpts
EditorOpts
InteractiveContext
Keypress
PasswordOpts
PromptContext
SearchOpts
SelectOption
SelectOpts
TextOpts
Type Aliases
PromptRenderer
Variables
confirm
editor
password
text
Functions
createInteractivePrompt
createPrompt
search
select
@convoker/theme
Interfaces
Theme
Variables
bgBlack
bgBlue
bgBlueBright
bgCyan
bgCyanBright
bgGray
bgGreen
bgGreenBright
bgMagenta
bgMagentaBright
bgRed
bgRedBright
bgWhite
bgWhiteBright
bgYellow
bgYellowBright
black
blue
blueBright
bold
cyan
cyanBright
DEFAULT_THEME
dim
gray
green
greenBright
hidden
inverse
italic
magenta
magentaBright
overline
red
redBright
reset
strikethrough
supportsColor
underline
white
whiteBright
yellow
yellowBright
Functions
createAnsiColor
defineTheme
convoker
Namespaces
globals
functions
getTheme
setTheme
i
classes
InputValidationError
Option
Positional
functions
argument
convert
option
positional
validate
interfaces
Input
StandardSchemaV1
namespaces
StandardSchemaV1
interfaces
FailureResult
Issue
PathSegment
Props
SuccessResult
Types
type-aliases
InferInput
InferOutput
Result
type-aliases
BasicKind
InferEntry
InferInput
Kind
TypeOf
log
classes
WriteError
functions
error
fatal
info
setConfig
trace
warn
interfaces
Config
variables
DEFAULT_CONFIG
parsers
classes
UnixParserError
functions
bsd
gnu
positional
unix
verbose
windows
interfaces
Parser
ParseResult
UnixPreset
prompt
classes
PromptValidationError
functions
createInteractivePrompt
createPrompt
search
select
interfaces
ConfirmOpts
CoreOpts
EditorOpts
InteractiveContext
Keypress
PasswordOpts
PromptContext
SearchOpts
SelectOption
SelectOpts
TextOpts
type-aliases
PromptRenderer
variables
confirm
editor
password
text
theme
functions
createAnsiColor
defineTheme
interfaces
Theme
variables
bgBlack
bgBlue
bgBlueBright
bgCyan
bgCyanBright
bgGray
bgGreen
bgGreenBright
bgMagenta
bgMagentaBright
bgRed
bgRedBright
bgWhite
bgWhiteBright
bgYellow
bgYellowBright
black
blue
blueBright
bold
cyan
cyanBright
DEFAULT_THEME
dim
gray
green
greenBright
hidden
inverse
italic
magenta
magentaBright
overline
red
redBright
reset
strikethrough
supportsColor
underline
white
whiteBright
yellow
yellowBright
Classes
Command
ConvokerError
HelpAskedError
MissingRequiredArgumentError
MissingRequiredOptionError
TooManyArgumentsError
UnknownOptionError
Interfaces
CommandAlias
InputMapEntry
ValidatedParseResult
Type Aliases
ActionFn
Builder
ErrorFn
MiddlewareFn
GitHub
Select theme
Dark
Light
Auto
positional
positional
():
Parser
Defined in: packages/core/dist/index.d.mts:135
Returns
Section titled “Returns”
Parser