From d09c1c982e8d2f3b854a09f00f923d45f61fbf98 Mon Sep 17 00:00:00 2001
From: Al Snow <43523+jasnow@users.noreply.github.com>
Date: Mon, 22 Jun 2026 12:06:00 -0400
Subject: [PATCH] Added results from usage research

---
 ba-usage.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 ba-usage.md

diff --git a/ba-usage.md b/ba-usage.md
new file mode 100644
index 00000000..0947eb28
--- /dev/null
+++ b/ba-usage.md
@@ -0,0 +1,31 @@
+This is what I wanted the usage command to return:
+```
+Usage:
+  bundle-audit [COMMAND] [OPTIONS]
+
+Commands:
+  check, -c [DIR]     # Scan Gemfile.lock for insecure dependencies.
+  update, -u          # Update the ruby-advisory-db.
+  version             # Prints the bundler-audit version.
+  help, -h [COMMAND]  # Describe available commands or one specific command.
+  download            # Downloads ruby-advisory-db.
+  stats               # Prints ruby-advisory-db stats.
+  tree                # Print a tree of all available commands.
+   
+Options for `check`:
+  --update, -u        # Update ruby-advisory-db before scanning.
+  --no-update         # Do not update the advisory database.
+  --verbose, -v       # Show full advisory details.
+  --quiet, -q         # Suppress normal output (exit codes only).
+  --ignore FILE       # Ignore one or more advisory IDs (repeatable).
+  --only FILE         # Only check the specified advisory IDs.
+  --gemfile PATH      # Use a specific Gemfile.lock.
+  --format FORMAT     # Output format: text (default), json, yaml
+
+Examples:
+  bundle-audit check
+  bundle-audit check --verbose
+  bundle-audit check --ignore CVE-2020-1234
+  bundle-audit check --format json > audit.json
+  bundle-audit update
+```