bun-types/docs/guides/process/argv.mdx

Type definitions and documentation for Bun, an incredibly fast JavaScript runtime

---
title: Parse command-line arguments
sidebarTitle: Parse command-line arguments
mode: center
---

The _argument vector_ is the list of arguments passed to the program when it is run. It is available as `Bun.argv`.

```ts cli.ts icon="/icons/typescript.svg"
console.log(Bun.argv);
```

---

Running this file with arguments results in the following:

```sh terminal icon="terminal"
bun run cli.ts --flag1 --flag2 value
```

```txt
[ '/path/to/bun', '/path/to/cli.ts', '--flag1', '--flag2', 'value' ]
```

---

To parse `argv` into a more useful format, `util.parseArgs` would be helpful.

Example:

```ts cli.ts icon="/icons/typescript.svg"
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);
```

---

then it outputs

```sh terminal icon="terminal"
bun run cli.ts --flag1 --flag2 value
```

```txt
{
  flag1: true,
  flag2: "value",
}
[ "/path/to/bun", "/path/to/cli.ts" ]
```