Command Line ArgsAPI Reference
API Reference
Complete API documentation for @visulima/command-line-args.
Last updated:
API Reference
Functions
parseArgs(definitions, options?)
Parse command-line arguments.
Parameters:
definitions(OptionDefinition[]): Option definitionsoptions(ParseOptions, optional): Parsing options
Returns: Parsed options object
commandLineArgs(definitions, options?)
Alias for parseArgs() (backward compatibility).
Types
OptionDefinition
interface OptionDefinition {
name: string; // Option name
alias?: string; // Short alias
type?: TypeConstructor; // String, Number, Boolean
defaultValue?: any; // Default value
multiple?: boolean; // Allow multiple values
defaultOption?: boolean; // Capture positional args
}ParseOptions
interface ParseOptions {
partial?: boolean; // Preserve unknown options
stopAtFirstUnknown?: boolean; // Stop at unknown option
camelCase?: boolean; // Convert to camelCase
argv?: string[]; // Custom argv array
}Examples
Basic:
parseArgs([{ name: "file", type: String }]);With alias:
parseArgs([{ name: "verbose", alias: "v", type: Boolean }]);Multiple values:
parseArgs([{ name: "include", type: String, multiple: true }]);Default value:
parseArgs([{ name: "port", type: Number, defaultValue: 3000 }]);Positional:
parseArgs([{ name: "files", type: String, multiple: true, defaultOption: true }]);