clide-js

Run

RunParams
run

Command

CommandModule
CommandHandler
passThroughCommand
command

State

State
NextState

Context

Context
ContextParams

Client

Client
PromptParams
PromptPrimitiveType

Plugin

Plugin
PluginInfo

Hooks

ClideHooks
HookName
HookPayload

Help

HelpRows
Help
getHelp

Errors

ClideError
ClientError
CommandRequiredError
MissingDefaultExportError
NotFoundError
OptionConflictsError
OptionRequiredError
OptionRequiresError
OptionsConfigError
OptionsError
SubcommandRequiredError
UsageError

Resolve

ResolveCommandParams
ResolvedCommand
Params
ResolveCommandFn
formatFileName
prepareResolvedCommand
resolveCommand

Parse

ParseCommandFn
ParsedCommand
Tokens
parseCommand

Classes

HookRegistry

Functions

disableLogger
enableLogger
joinTokens
optionPrompt
splitTokens
toggleLogger

Interfaces

ClideErrorOptions
GetHelpOptions
LoggerHooks
LoggerMeta

Options

CreateOptionsGetterOptions
OptionCustomTypeMap
OptionPrimitiveTypeMap
ExpandedOptionsConfig
OptionAlias
OptionBaseType
OptionConfig
OptionCustomType
OptionGetter
OptionPrimitiveType
OptionsConfig
OptionsGetter
OptionType
OptionValues
createOptionsGetter
getOptionDisplayName
getOptionKeys
getOptionTypeFromValue
normalizeOptionValue
option
options
removeOptionTokens
validateOptions
validateOptionsConfig
validateOptionType

Plugins

HelpPluginOptions
help
logger

Type Aliases

JoinableTokens
OptionArgumentType
OptionConfigPrimitiveType
OptionConfigType
OptionKey
OptionPromptParams
OptionPromptType
OptionPromptTypeMap
PromptTypeMap

Utils

CamelCase
camelCase
findSimilar
getBin
getCallerPath
hideBin
isDirectory
isFile
parseFileName
removeFileExtension

Settings

Member Visibility

On This Page

Run
Command
State
Context
Client
Plugin
Hooks
Help
Errors
Resolve
Parse
Classes
Functions
Interfaces
Options
Plugins
Type Aliases
Utils