Parse command-line arguments

The argument vector is the list of arguments passed to the program when it is run. It is available as Bun.argv.

cli.ts

console.log(Bun.argv);

Running this file with arguments results in the following:

terminal

bun run cli.ts --flag1 --flag2 value

[ "/path/to/bun", "/path/to/cli.ts", "--flag1", "--flag2", "value" ]

To parse argv into a more useful format, use util.parseArgs.

cli.ts

import { parseArgs } from "util";

const { values, positionals } = parseArgs({
  args: Bun.argv,
  options: {
    flag1: {
      type: "boolean",
    },
    flag2: {
      type: "string",
    },
  },
  strict: true,
  allowPositionals: true,
});

console.log(values);
console.log(positionals);

Running cli.ts with the same arguments prints the parsed values.

terminal

bun run cli.ts --flag1 --flag2 value

[Object: null prototype] {
  flag1: true,
  flag2: "value",
}
[ "/path/to/bun", "/path/to/cli.ts" ]

Overview

Deployment

Runtime & Debugging

Utilities

Ecosystem & Frameworks

HTTP & Networking

WebSocket

Processes & System

Package Manager

Test Runner

Runtime & Debugging

Module System

File System

Utilities

HTML Processing

Binary Data

Streams

Parse command-line arguments