BARGS
    Preparing search index...

      BARGS

      Main entry point for the bargs CLI argument parser.

      Provides a combinator-style API for building type-safe CLIs.

      import { bargs, opt, pos } from '@boneskull/bargs';

      await bargs('my-app', { version: '1.0.0' })
      .globals(opt.options({ verbose: opt.boolean({ aliases: ['v'] }) }))
      .command(
      'greet',
      pos.positionals(pos.string({ name: 'name', required: true })),
      ({ positionals }) => console.log(`Hello, ${positionals[0]}!`),
      'Say hello',
      )
      .parseAsync();

      Classes

      BargsError
      HelpError
      ValidationError

      Interfaces

      ArrayOption
      BooleanOption
      CliBuilder
      CliResult
      Command
      CommandDef
      CountOption
      CreateOptions
      EnumArrayOption
      EnumOption
      EnumPositional
      HelpConfig
      NumberOption
      NumberPositional
      Parser
      ParseResult
      StringOption
      StringPositional
      Styler
      Theme
      ThemeColors
      TransformsConfig
      VariadicPositional

      Type Aliases

      CallableOptionsParser
      CallablePositionalsParser
      CamelCaseKeys
      HandlerFn
      InferOption
      InferOptions
      InferParserPositionals
      InferParserValues
      InferPositional
      InferPositionals
      InferTransformedPositionals
      InferTransformedValues
      KebabToCamel
      OptionDef
      OptionsSchema
      PositionalDef
      PositionalsSchema
      PositionalsTransformFn
      StyleFn
      ThemeInput
      TransformFn
      ValuesTransformFn

      Variables

      ansi
      defaultTheme
      opt
      pos
      themes

      Functions

      bargs
      camelCaseValues
      createStyler
      generateCommandHelp
      generateHelp
      handle
      linkifyUrls
      map
      merge
      stripAnsi