Index

Modules: ../examples/helloCommand, ../examples/helloWorldCommand, ../examples/newCommand, kapsis/commands, kapsis/db, kapsis/pluggable, kapsis/runtime.

API symbols

about:

• commands: about(info)

addCommand:

• commands: addCommand(cli: Kapsis; id, cmdId, desc: string; args: seq[ParamTuple]; callbackIdent: string; isSubCommand: bool; callback: Callback; isNative = true)

addDescription:

• commands: addDescription(cli: Kapsis; desc: string)

addSeparator:

• commands: addSeparator(cli: Kapsis; id: string; key: int)

addVersion:

• commands: addVersion(cli: Kapsis; vers: string)

App:

• commands: App(body)

Callback:

• commands: Callback

Command:

• commands: Command

commands:

• commands: commands(lines: untyped)

CommandType:

• commands: CommandType

ConflictCommandName:

• KapsisErrors.ConflictCommandName

Database:

• db: Database

dbJSON:

• DBType.dbJSON

dbLMDB:

• DBType.dbLMDB

dbMsgPacked:

• DBType.dbMsgPacked

dbSQLite:

• DBType.dbSQLite

DBType:

• db: DBType

flag:

• runtime: flag(values: Values; argName: string): bool

get:

• runtime: get(values: Values; argName: string): string

has:

• runtime: has(values: Values; argName: string): bool

initPlugins:

• pluggable: initPlugins(thread: var Thread[Kapsis]; cli: Kapsis)

Kapsis:

• commands: Kapsis

KapsisDefect:

• commands: KapsisDefect

KapsisErrors:

• commands: KapsisErrors

Key:

• ParameterType.Key

LongFlag:

• ParameterType.LongFlag

MaximumDepthSubCommand:

• KapsisErrors.MaximumDepthSubCommand

Parameter:

• commands: Parameter

ParameterType:

• commands: ParameterType

ParamTuple:

• commands: ParamTuple

ParentCommandNotFound:

• KapsisErrors.ParentCommandNotFound

plugAndPlay:

• PluginType.plugAndPlay

plugDynLib:

• PluginType.plugDynLib

pluggable:

• commands: pluggable(pluginType: set[PluginType])

PluginType:

• commands: PluginType

printUsage:

• commands: printUsage(cli: Kapsis): string

runCommand:

• helloCommand: runCommand(v: Values)
• helloWorldCommand: runCommand(v: Values)
• newCommand: runCommand(v: Values)

settings:

• commands: settings(database: static DBType; mainCmd: static string = "")

ShortFlag:

• ParameterType.ShortFlag

SyntaxError:

• commands: SyntaxError

toInt:

• runtime: toInt(str: string): int

typeCommandLine:

• CommandType.typeCommandLine

typeCommentLine:

• CommandType.typeCommentLine

typeSubCommandLine:

• CommandType.typeSubCommandLine

Values:

• commands: Values

Variant:

• ParameterType.Variant