aboutsummaryrefslogtreecommitdiff
path: root/docs/guides/process/argv.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides/process/argv.md')
-rw-r--r--docs/guides/process/argv.md22
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).