# ultraflag

**Repository Path**: mirrors_TrySound/ultraflag

## Basic Information

- **Project Name**: ultraflag
- **Description**: <1kB CLI flag parser
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-02-16
- **Last Updated**: 2025-09-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# `ultraflag`

A 730B library for parsing CLI flags. Inspired by Deno's `std` [`flags`](https://github.com/denoland/deno_std/blob/main/flags/mod.ts) module.

### Features

- It's very small.
- It's very fast.

### Usage

Basic usage does not require any configuration.

```js
import { parse } from "ultraflag";

// my-cli build --bundle -rf --a value --b=value --c 1
const argv = process.argv.slice(2);
const args = parse(argv);

console.log(args);
// { _: ['build'], bundle: true, r: true, f: true, a: "value", b: "value", c: 1 }
```

Parsing can be configured to ensure values are handled in a certain format.

```js
const args = parse(argv, {
  default: { a: 1, b: 2, c: "value" },
  alias: { h: "help" },
  boolean: ["foo", "bar"],
  string: ["baz", "qux"],
  array: ["input"],
});
```

## Benchmarks

```
mri           x 1,285,159 ops/sec ±0.29% (90 runs sampled)
ultraflag     x 986,699 ops/sec ±0.38% (91 runs sampled)
minimist      x 250,866 ops/sec ±0.59% (92 runs sampled)
yargs-parser  x 18,153 ops/sec ±4.30% (85 runs sampled)
```