Index

Modules: kapsis, kapsis/framework, kapsis/interactive/prompts, kapsis/interactive/spinny, kapsis/interactive/spinny/colorize, kapsis/interactive/spinny/spinners, kapsis/runtime, kapsis/types.

API symbols

`$`:

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

askEmail:

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

askIP4:

• prompts: 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:

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

blueSpan:

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

bold:

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

CmdArg:

• framework: type CmdArg

CmdArgValueType:

• types: enum CmdArgValueType

cmdCommand:

• framework: CommandType.cmdCommand

cmdGroup:

• framework: CommandType.cmdGroup

cmdSeparator:

• framework: CommandType.cmdSeparator

collectValues:

• types: template collectValues(values: var ValuesTable; argName: string; val: sink string; arg)

Command:

• framework: type Command

CommandType:

• framework: enum CommandType

cyanSpan:

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

display:

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

displayError:

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

displayInfo:

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

displaySuccess:

• prompts: proc displaySuccess(x: string)

displayWarning:

• prompts: proc displayWarning(x: string)
• prompts: proc displayWarning(x: varargs[Span])
• prompts: 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:

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

getDays:

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

getDir:

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

getFile:

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

getFilename:

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

getFilepath:

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

getFloat:

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

getHours:

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

getIdent:

• types: proc getIdent(value: Value): lent string

getInt:

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

getJson:

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

getMilliseconds:

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

getMinutes:

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

getMonths:

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

getPath:

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

getPort:

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

getSeconds:

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

getStr:

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

getUrl:

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

getYaml:

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

getYears:

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

green:

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

greenSpan:

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

has:

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

hidden:

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

initApp:

• framework: template initApp(stmtNodes: untyped)

initCLI:

• framework: template initCLI(stmtNodes: untyped)

initCLIApplication:

• framework: template initCLIApplication(stmtNodes: untyped)

initKapsis:

• framework: macro initKapsis(stmtNodes: untyped)

invert:

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

Kapsis:

• framework: type Kapsis

KapsisErrorMessage:

• types: enum KapsisErrorMessage

KapsisInputValue:

• prompts: object KapsisInputValue

KapsisPath:

• types: object KapsisPath

ktBool:

• types: CmdArgValueType.ktBool

ktDays:

• types: CmdArgValueType.ktDays

ktDir:

• types: CmdArgValueType.ktDir

ktFile:

• types: CmdArgValueType.ktFile

ktFilename:

• types: CmdArgValueType.ktFilename

ktFilepath:

• types: CmdArgValueType.ktFilepath

ktFloat:

• types: CmdArgValueType.ktFloat

ktHours:

• types: CmdArgValueType.ktHours

ktIdent:

• types: CmdArgValueType.ktIdent

ktInt:

• types: CmdArgValueType.ktInt

ktJson:

• types: CmdArgValueType.ktJson

ktMilliseconds:

• types: CmdArgValueType.ktMilliseconds

ktMinutes:

• types: CmdArgValueType.ktMinutes

ktMonths:

• types: CmdArgValueType.ktMonths

ktPath:

• types: CmdArgValueType.ktPath

ktPort:

• types: CmdArgValueType.ktPort

ktSeconds:

• types: CmdArgValueType.ktSeconds

ktString:

• types: CmdArgValueType.ktString

ktUrl:

• types: CmdArgValueType.ktUrl

ktYaml:

• types: CmdArgValueType.ktYaml

ktYears:

• types: CmdArgValueType.ktYears

makeSpinner:

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

missingArgument:

• types: KapsisErrorMessage.missingArgument

newSpinny:

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

printError:

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

prompt:

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

promptConfirm:

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

promptSecret:

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

Row:

• prompts: type Row

rows:

• prompts: 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)

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:

• prompts: tuple Span

span:

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

Spinner:

• spinners: object Spinner

Spinny:

• spinny: type Spinny

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:

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

toString:

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

typeMismatch:

• types: KapsisErrorMessage.typeMismatch

underline:

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

unexpectedOption:

• types: KapsisErrorMessage.unexpectedOption

unknownCommand:

• types: KapsisErrorMessage.unknownCommand

unknownOption:

• types: KapsisErrorMessage.unknownOption

url:

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

Value:

• types: object Value

Values:

• types: type Values

ValuesTable:

• types: type ValuesTable

yellow:

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

yellowSpan:

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