Index

Modules: kapsis, kapsis/app, kapsis/cli, kapsis/interactive/spinny, kapsis/interactive/spinny/colorize, kapsis/interactive/spinny/spinners, kapsis/runtime.

API symbols

`$`:

• runtime: proc `$`(x: KapsisPath): string

addArg:

• app: proc addArg(cmd: KapsisCommand; id: string; kind: CmdLineKind; datatype: KapsisValueType; argtype = KapsisArgType.katArg; isOpt = false)

addCommand:

• app: proc addCommand(k: KapsisCli; key: string; cmd: KapsisCommand)
• app: proc addCommand(k: KapsisCli; parent, key: string; cmd: KapsisCommand)

addVariant:

• app: proc addVariant(cmd: KapsisCommand; id: string; argVariant: openArray[string])

askEmail:

• cli: proc askEmail(label: string; default = ""; skippable = false): string

askIP4:

• cli: proc askIP4(label: string; default = ""; skippable = false): string

bgBlack:

• colorize: proc bgBlack(s: string): string

bgBlue:

• colorize: proc bgBlue(s: string): string

bgCyan:

• colorize: proc bgCyan(s: string): string

bgDarkGray:

• colorize: proc bgDarkGray(s: string): string

bgGreen:

• colorize: proc bgGreen(s: string): string

bgLightBlue:

• colorize: proc bgLightBlue(s: string): string

bgLightCyan:

• colorize: proc bgLightCyan(s: string): string

bgLightGray:

• colorize: proc bgLightGray(s: string): string

bgLightGreen:

• colorize: proc bgLightGreen(s: string): string

bgLightMagenta:

• colorize: proc bgLightMagenta(s: string): string

bgLightRed:

• colorize: proc bgLightRed(s: string): string

bgLightYellow:

• colorize: proc bgLightYellow(s: string): string

bgMagenta:

• colorize: proc bgMagenta(s: string): string

bgRed:

• colorize: proc bgRed(s: string): string

bgWhite:

• colorize: proc bgWhite(s: string): string

bgYellow:

• colorize: proc bgYellow(s: string): string

blue:

• cli: proc blue(label: string; indentSize = 1): Span

blueSpan:

• cli: proc blueSpan(label: string; indentSize = 1): Span

bold:

• colorize: proc bold(s: string): string

commands:

• app: macro commands(registeredCommands: untyped; extras: untyped = nil)

ctCmd:

• app: KapsisCommandType.ctCmd

ctCmdDir:

• app: KapsisCommandType.ctCmdDir

ctCmdSep:

• app: KapsisCommandType.ctCmdSep

cyanSpan:

• cli: proc cyanSpan(label: string; indentSize = 1): Span

display:

• cli: proc display(i: int; spans: varargs[Span])
• cli: proc display(spans: seq[Span])
• cli: proc display(label: string; indent = 0; br = "")
• cli: proc display(spans: varargs[Span])

displayError:

• cli: proc displayError(x: string; quitProcess = false)
• cli: proc displayError(x: varargs[Span])

displayInfo:

• cli: proc displayInfo(x: string)
• cli: proc displayInfo(x: varargs[Span])
• cli: proc displayInfo(x: varargs[Span]; indentSize: int)

displaySuccess:

• cli: proc displaySuccess(x: string)

displayWarning:

• cli: proc displayWarning(x: string)
• cli: proc displayWarning(x: varargs[Span])
• cli: proc displayWarning(x: varargs[Span]; indentSize: int)

error:

• spinny: proc error(spinny: Spinny; msg: string)

fgBlack:

• colorize: proc fgBlack(s: string): string

fgBlue:

• colorize: proc fgBlue(s: string): string

fgCyan:

• colorize: proc fgCyan(s: string): string

fgDarkGray:

• colorize: proc fgDarkGray(s: string): string

fgGreen:

• colorize: proc fgGreen(s: string): string

fgLightBlue:

• colorize: proc fgLightBlue(s: string): string

fgLightCyan:

• colorize: proc fgLightCyan(s: string): string

fgLightGray:

• colorize: proc fgLightGray(s: string): string

fgLightGreen:

• colorize: proc fgLightGreen(s: string): string

fgLightMagenta:

• colorize: proc fgLightMagenta(s: string): string

fgLightRed:

• colorize: proc fgLightRed(s: string): string

fgLightYellow:

• colorize: proc fgLightYellow(s: string): string

fgMagenta:

• colorize: proc fgMagenta(s: string): string

fgRed:

• colorize: proc fgRed(s: string): string

fgWhite:

• colorize: proc fgWhite(s: string): string

fgYellow:

• colorize: proc fgYellow(s: string): string

get:

• runtime: proc get(values: Values; key: string): Value

getBool:

• app: proc getBool(value: Value): lent bool

getDays:

• app: proc getDays(value: Value): lent Duration

getDir:

• app: proc getDir(value: Value): lent KapsisPath

getFile:

• app: proc getFile(value: Value): lent KapsisPath

getFilename:

• app: proc getFilename(value: Value): lent string

getFilepath:

• app: proc getFilepath(value: Value): lent string

getFloat:

• app: proc getFloat(value: Value): lent float

getHours:

• app: proc getHours(value: Value): lent Duration

getInt:

• app: proc getInt(value: Value): lent int

getJson:

• app: proc getJson(value: Value): lent JsonNode

getMilliseconds:

• app: proc getMilliseconds(value: Value): lent Duration

getMinutes:

• app: proc getMinutes(value: Value): lent Duration

getMonths:

• app: proc getMonths(value: Value): lent Duration

getPath:

• app: proc getPath(value: Value): lent KapsisPath

getPort:

• app: proc getPort(value: Value): lent Port

getSeconds:

• app: proc getSeconds(value: Value): lent Duration

getStr:

• app: proc getStr(value: Value): lent string

getUrl:

• app: proc getUrl(value: Value): lent Uri

getYaml:

• app: proc getYaml(value: Value): lent string

getYears:

• app: proc getYears(value: Value): lent Duration

green:

• cli: proc green(label: string; indentSize = 1): Span

greenSpan:

• cli: proc greenSpan(label: string; indentSize = 1): Span

has:

• runtime: proc has(values: Values; key: string): bool

hidden:

• colorize: proc hidden(s: string): string

invert:

• colorize: proc invert(s: string): string

isBool:

• app: proc isBool(v: string): bool

isFloat:

• app: proc isFloat(v: string): bool

isInt:

• app: proc isInt(v: string): bool

Kapsis:

• app: var Kapsis

KapsisArgType:

• app: enum KapsisArgType

KapsisArgument:

• app: object KapsisArgument

KapsisCommand:

• app: type KapsisCommand

KapsisCommandType:

• app: enum KapsisCommandType

KapsisErrorMessage:

• app: enum KapsisErrorMessage

KapsisInput:

• app: tuple KapsisInput

KapsisInputValue:

• cli: object KapsisInputValue

KapsisPath:

• app: object KapsisPath

KapsisValueType:

• app: enum KapsisValueType

katArg:

• app: KapsisArgType.katArg

katVariant:

• app: KapsisArgType.katVariant

makeSpinner:

• spinners: proc makeSpinner(interval: int; frames: openArray[string]): Spinner

missingArg:

• app: KapsisErrorMessage.missingArg

missingArgument:

• app: KapsisErrorMessage.missingArgument

newSpinny:

• spinny: proc newSpinny(text: string; s: Spinner; time = false): Spinny

printError:

• app: template printError(msg: KapsisErrorMessage; arg: varargs[string])

printUsage:

• app: proc printUsage(showExtras = false; showCommand = newStringOfCap(0); showSubCommands = false)

prompt:

• cli: proc prompt(label: string; color: string = "white"; default = ""): string

promptConfirm:

• cli: proc promptConfirm(label: string; icon: string = "👉"): bool

promptSecret:

• cli: proc promptSecret(label: string; color: string = "white"; required = true): string

Row:

• cli: type Row

rows:

• cli: iterator rows(items: seq[Row]): Row

setSymbol:

• spinny: proc setSymbol(spinny: Spinny; symbol: string)

setSymbolColor:

• spinny: proc setSymbolColor(spinny: Spinny; color: proc (x: string): string)

setText:

• spinny: proc setText(spinny: Spinny; text: string)

settings:

• app: macro settings(mainCommand: static Option[string] = none(string); exitAfterCallback: static bool = true; heading: static string = "")

skArc:

• spinners: const skArc

skArrow:

• spinners: const skArrow

skArrow2:

• spinners: const skArrow2

skArrow3:

• spinners: const skArrow3

skBalloon:

• spinners: const skBalloon

skBalloon2:

• spinners: const skBalloon2

skBetaWave:

• spinners: const skBetaWave

skBounce:

• spinners: const skBounce

skBouncingBall:

• spinners: const skBouncingBall

skBouncingBar:

• spinners: const skBouncingBar

skBoxBounce:

• spinners: const skBoxBounce

skBoxBounce2:

• spinners: const skBoxBounce2

skChristmas:

• spinners: const skChristmas

skCircle:

• spinners: const skCircle

skCircleHalves:

• spinners: const skCircleHalves

skCircleQuarters:

• spinners: const skCircleQuarters

skClock:

• spinners: const skClock

skDots:

• spinners: const skDots

skDots10:

• spinners: const skDots10

skDots11:

• spinners: const skDots11

skDots12:

• spinners: const skDots12

skDots2:

• spinners: const skDots2

skDots3:

• spinners: const skDots3

skDots4:

• spinners: const skDots4

skDots5:

• spinners: const skDots5

skDots6:

• spinners: const skDots6

skDots7:

• spinners: const skDots7

skDots8:

• spinners: const skDots8

skDots8Bit:

• spinners: const skDots8Bit

skDots9:

• spinners: const skDots9

skDqpb:

• spinners: const skDqpb

skEarth:

• spinners: const skEarth

skFlip:

• spinners: const skFlip

skGrenade:

• spinners: const skGrenade

skGrowHorizontal:

• spinners: const skGrowHorizontal

skGrowVertical:

• spinners: const skGrowVertical

skHamburger:

• spinners: const skHamburger

skHearts:

• spinners: const skHearts

skLayer:

• spinners: const skLayer

skLine:

• spinners: const skLine

skLine2:

• spinners: const skLine2

skMonkey:

• spinners: const skMonkey

skMoon:

• spinners: const skMoon

skNoise:

• spinners: const skNoise

skPipe:

• spinners: const skPipe

skPoint:

• spinners: const skPoint

skPong:

• spinners: const skPong

skRunner:

• spinners: const skRunner

skShark:

• spinners: const skShark

skSimpleDots:

• spinners: const skSimpleDots

skSimpleDotsScrolling:

• spinners: const skSimpleDotsScrolling

skSmiley:

• spinners: const skSmiley

skSquareCorners:

• spinners: const skSquareCorners

skSquish:

• spinners: const skSquish

skStar:

• spinners: const skStar

skStar2:

• spinners: const skStar2

skToggle:

• spinners: const skToggle

skToggle10:

• spinners: const skToggle10

skToggle11:

• spinners: const skToggle11

skToggle12:

• spinners: const skToggle12

skToggle13:

• spinners: const skToggle13

skToggle2:

• spinners: const skToggle2

skToggle3:

• spinners: const skToggle3

skToggle4:

• spinners: const skToggle4

skToggle5:

• spinners: const skToggle5

skToggle6:

• spinners: const skToggle6

skToggle7:

• spinners: const skToggle7

skToggle8:

• spinners: const skToggle8

skToggle9:

• spinners: const skToggle9

skTriangle:

• spinners: const skTriangle

skWeather:

• spinners: const skWeather

Span:

• cli: tuple Span

span:

• cli: proc span(label: string; fg = fgDefault; bg = bgDefault; indentSize = 1): Span

Spinner:

• spinners: object Spinner

start:

• spinny: proc start(spinny: Spinny)

stop:

• spinny: proc stop(spinny: Spinny)

success:

• spinny: proc success(spinny: Spinny)
• spinny: proc success(spinny: Spinny; msg: string)

toggle:

• cli: proc toggle(onOff: bool): Span

toString:

• cli: proc toString(spans: seq[Span]): string

typeMismatch:

• app: KapsisErrorMessage.typeMismatch

underline:

• colorize: proc underline(s: string): string

unexpectedOption:

• app: KapsisErrorMessage.unexpectedOption

unknownCommand:

• app: KapsisErrorMessage.unknownCommand

unknownOption:

• app: KapsisErrorMessage.unknownOption

url:

• cli: proc url(uri: string; port: int = 0; ssl = false): Span

Value:

• app: object Value

Values:

• app: type Values

vtBool:

• app: KapsisValueType.vtBool

vtDays:

• app: KapsisValueType.vtDays

vtDir:

• app: KapsisValueType.vtDir

vtFile:

• app: KapsisValueType.vtFile

vtFilename:

• app: KapsisValueType.vtFilename

vtFilepath:

• app: KapsisValueType.vtFilepath

vtFloat:

• app: KapsisValueType.vtFloat

vtHours:

• app: KapsisValueType.vtHours

vtInt:

• app: KapsisValueType.vtInt

vtJson:

• app: KapsisValueType.vtJson

vtMilliseconds:

• app: KapsisValueType.vtMilliseconds

vtMinutes:

• app: KapsisValueType.vtMinutes

vtMonths:

• app: KapsisValueType.vtMonths

vtPath:

• app: KapsisValueType.vtPath

vtPort:

• app: KapsisValueType.vtPort

vtSeconds:

• app: KapsisValueType.vtSeconds

vtString:

• app: KapsisValueType.vtString

vtUrl:

• app: KapsisValueType.vtUrl

vtYaml:

• app: KapsisValueType.vtYaml

vtYears:

• app: KapsisValueType.vtYears

yellow:

• cli: proc yellow(label: string; indentSize = 1): Span

yellowSpan:

• cli: proc yellowSpan(label: string; indentSize = 1): Span