Skip to content

Main Navigation Guide

Completions Plugin

Friendly Error Plugin

Not Found Plugin

Strict Flags Plugin

Update Notifier Plugin

English

English

Appearance

Sidebar Navigation

Go back to guide

API Reference

BaseContext

Clerc

ClercFlagDefinitionValue

ClercFlagOptions

ClercFlagsDefinition

Cli

Command

CommandCustomOptions

CommandHandler

CommandHandlerContext

CommandHelpOptions

CommandOptions

CommandsMap

CommandsRecord

CommandWithHandler

completionsPlugin

ContextStore

CreateOptions

createStopAtFirstParameter

defaultFormatters

defineCommand

definePlugin

DOUBLE_DASH

ErrorHandler

extractParameterInfo

FlagCustomOptions

friendlyErrorPlugin

FriendlyErrorPluginOptions

GroupDefinition

GroupsOptions

HelpOptions

helpPlugin

HelpPluginOptions

InferParameters

Interceptor

InterceptorContext

InterceptorHandler

InterceptorNext

InterceptorObject

InvalidCommandError

InvalidParametersError

KNOWN_FLAG

MakeEmitterEvents

MissingRequiredFlagError

MissingRequiredMetadataError

NoCommandSpecifiedError

normalizeFlagValue

normalizeParameterValue

NoSuchCommandError

notFoundPlugin

NotFoundPluginOptions

PARAMETER

ParameterCustomOptions

ParameterDefinitionValue

ParameterOptions

ParseOptions

Parser

BaseFlagOptions

createParser

FlagDefaultValue

FlagDefaultValueFunction

FlagDefinitionValue

FlagOptions

FlagsDefinition

IgnoreFunction

InferFlags

InvalidSchemaError

ObjectInputType

parse

ParsedResult

ParserOptions

RawInputType

TypeFunction

TypeValue

Plugin

resolveCommand

strictFlagsPlugin

Types

Enum

FlagValidationError

Range

Regex

UNKNOWN_FLAG

updateNotifierPlugin

UpdateNotifierPluginOptions

versionPlugin

This page

Type Alias: ClercFlagsDefinition

ts

type ClercFlagsDefinition
 = Record
<string, ClercFlagDefinitionValue
>;

Defined in: packages/core/src/types/flag.ts:11

Suggest to this page

Pager

PreviousClercFlagOptions

Released under the MIT license

Copyright © 2023-present Clerc Developers