The argument vector is the list of arguments passed to the program when it is run. It is available as Bun.argv
.
console.log(Bun.argv);
Running this file with arguments results in the following:
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, util.parseArgs
would be helpful.
Example:
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
$ bun run cli.ts --flag1 --flag2 value
{
flag1: true,
flag2: "value",
}
[ "/path/to/bun", "/path/to/cli.ts" ]