guides.md

Documentación

• Documentación
  • Procs
    • processCmd
    • processHelp
    • getArgs
    • getFlags
  • Types
    • CmdosArgs y CmdosFlags

Procs

processCmd

La función processArgs se utiliza para interpretar y procesar las entradas del usuario para un comando específico.

proc processCmd*(cmd: static CmdosCmd, ignoreFirst: bool = false, inputs: seq[string] = defaultArgs): (CmdosFlags, CmdosArgs) =

• cmd: El comando específico que se va a procesar. Este parámetro es obligatorio y debe ser de tipo CmdosCmd (ver Types).
• ignoreFirst:
• inputs (opcional): Una secuencia de cadenas de texto que representan las entradas del usuario. Si no se proporcionan, se utilizarán las entradas por defecto.

processHelp

La función processHelp genera un mensaje de ayuda basado en los datos proporcionados. Es útil para mostrar al usuario cómo utilizar un comando o conjunto de comandos.

proc processHelp*(data: static Cmdos): string

• data: Los datos que se utilizarán para generar el mensaje de ayuda (ver Types).

getArgs

# Get the value of an option
proc getArgs*(data: CmdosArgs, optLongName: string): seq[string]

getFlags

# Get the value of a flag
proc getFlags*(data: CmdosFlags, optLongName: string): bool

Types

type
  CmdosOpt* = object
    names*: seq[string]
    inputs*: seq[string]
    desc*: string
    label*: string

  CmdosCmd* = object
    names*: seq[string]
    desc*: string
    opts*: seq[CmdosOpt]

  Cmdos* = object
    name*: string
    cmds*: seq[CmdosCmd]

CmdosArgs y CmdosFlags

El tipo CmdosArgs y CmdosFlags se utiliza para manejar los datos procesados por processCmd.

type
  CmdosArgs* = seq[tuple[data: seq[string]]]
  CmdosFlags* = seq[string]