diff options
author | 2023-07-26 14:59:39 -0700 | |
---|---|---|
committer | 2023-07-26 14:59:39 -0700 | |
commit | 4c89c60867591b50e0b31bf5009fd5ad6a3cebe1 (patch) | |
tree | fc1d2f47309c0345a850933496baa40d94bfdcbb /docs/guides/process/argv.md | |
parent | 6bfee02301a2e2a0b79339974af0445eb5a2688f (diff) | |
download | bun-4c89c60867591b50e0b31bf5009fd5ad6a3cebe1.tar.gz bun-4c89c60867591b50e0b31bf5009fd5ad6a3cebe1.tar.zst bun-4c89c60867591b50e0b31bf5009fd5ad6a3cebe1.zip |
Add files (#3826)
Diffstat (limited to 'docs/guides/process/argv.md')
-rw-r--r-- | docs/guides/process/argv.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/guides/process/argv.md b/docs/guides/process/argv.md new file mode 100644 index 000000000..f9f3c77e4 --- /dev/null +++ b/docs/guides/process/argv.md @@ -0,0 +1,22 @@ +--- +name: 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`. + +```ts#cli.ts +console.log(Bun.argv); +``` + +--- + +Running this file with arguments results in the following: + +```sh +$ bun run cli.tsx --flag1 --flag2 value +[ '/path/to/bun', '/path/to/cli.ts', '--flag1', '--flag2', 'value' ] +``` + +--- + +To parse `argv` into a more useful format, consider using [minimist](https://github.com/minimistjs/minimist) or [commander](https://github.com/tj/commander.js). |