docs: improve commands generation

Bearer · Dec 21, 2023 · 1e1528b · 1e1528b
1 parent 11beff4
commit 1e1528b
Show file tree

Hide file tree

Showing 20 changed files with 656 additions and 456 deletions.
diff --git a/docs/_data/bearer.yaml b/docs/_data/bearer.yaml
@@ -1,13 +1,12 @@
 name: bearer
 options:
-  - name: help
-    shorthand: h
-    default_value: "false"
-    usage: help for bearer
+    - name: help
+      shorthand: h
+      default_value: "false"
+      usage: help for bearer
 see_also:
-  - bearer completion - Generate the autocompletion script for the your shell.
-  - bearer ignore - Manage ignored fingerprints
-  - bearer init - Generates a default config to `bearer.yml`
-  - bearer scan - Scan a directory or file
-  - bearer version - Print the version
-aliases:
+    - bearer completion - Generate the autocompletion script for the your shell.
+    - bearer ignore - Manage ignored fingerprints
+    - bearer init - Generates a default config to `bearer.yml`
+    - bearer scan - Scan a directory or file
+    - bearer version - Print the version
diff --git a/docs/_data/bearer_completion.yaml b/docs/_data/bearer_completion.yaml
@@ -2,10 +2,9 @@ name: bearer completion
 synopsis: Generate the autocompletion script for the your shell.
 usage: bearer completion [command]
 options:
-  - name: help
-    shorthand: h
-    default_value: "false"
-    usage: help for completion
+    - name: help
+      shorthand: h
+      default_value: "false"
+      usage: help for completion
 see_also:
-  - "bearer - "
-aliases:
+    - 'bearer - '
diff --git a/docs/_data/bearer_ignore_add.yaml b/docs/_data/bearer_ignore_add.yaml
@@ -2,54 +2,62 @@ name: bearer ignore add
 synopsis: Add an ignored fingerprint
 usage: bearer ignore add <fingerprint> [flags]
 options:
-  - name: api-key
-    usage: Use your Bearer API Key to send the report to Bearer.
-  - name: author
-    shorthand: a
-    usage: |
-      Add author information to this ignored finding. (default output of "git config user.name")
-  - name: comment
-    usage: Add a comment to this ignored finding.
-  - name: config-file
-    default_value: bearer.yml
-    usage: Load configuration from the specified path.
-  - name: debug
-    default_value: "false"
-    usage: Enable debug logs. Equivalent to --log-level=debug
-  - name: debug-profile
-    default_value: "false"
-    usage: Generate profiling data for debugging
-  - name: disable-version-check
-    default_value: "false"
-    usage: Disable Bearer version checking
-  - name: false-positive
-    default_value: "false"
-    usage: Mark an this ignored finding as false positive.
-  - name: force
-    default_value: "false"
-    usage: Overwrite an existing ignored finding.
-  - name: help
-    shorthand: h
-    default_value: "false"
-    usage: help for add
-  - name: host
-    default_value: my.bearer.sh
-    usage: Specify the Host for sending the report.
-  - name: ignore-file
-    default_value: bearer.ignore
-    usage: Load ignore file from the specified path.
-  - name: ignore-git
-    default_value: "false"
-    usage: Ignore Git listing
-  - name: log-level
-    default_value: info
-    usage: Set log level (error, info, debug, trace)
-  - name: no-color
-    default_value: "false"
-    usage: Disable color in output
+    - name: author
+      shorthand: a
+      usage: |
+        Add author information to this ignored finding. (default output of "git config user.name")
+      environment_variables:
+        - BEARER_AUTHOR
+    - name: comment
+      usage: Add a comment to this ignored finding.
+      environment_variables:
+        - BEARER_COMMENT
+    - name: config-file
+      default_value: bearer.yml
+      usage: Load configuration from the specified path.
+      environment_variables:
+        - BEARER_CONFIG_FILE
+    - name: debug
+      default_value: "false"
+      usage: Enable debug logs. Equivalent to --log-level=debug
+      environment_variables:
+        - BEARER_DEBUG
+    - name: disable-version-check
+      default_value: "false"
+      usage: Disable Bearer version checking
+      environment_variables:
+        - BEARER_DISABLE_VERSION_CHECK
+    - name: false-positive
+      default_value: "false"
+      usage: Mark an this ignored finding as false positive.
+      environment_variables:
+        - BEARER_FALSE_POSITIVE
+    - name: force
+      default_value: "false"
+      usage: Overwrite an existing ignored finding.
+      environment_variables:
+        - BEARER_FORCE
+    - name: help
+      shorthand: h
+      default_value: "false"
+      usage: help for add
+    - name: ignore-file
+      default_value: bearer.ignore
+      usage: Load ignore file from the specified path.
+      environment_variables:
+        - BEARER_IGNORE_FILE
+    - name: log-level
+      default_value: info
+      usage: Set log level (error, info, debug, trace)
+      environment_variables:
+        - BEARER_LOG_LEVEL
+    - name: no-color
+      default_value: "false"
+      usage: Disable color in output
+      environment_variables:
+        - BEARER_NO_COLOR
 example: |-
-  # Add an ignored fingerprint to your ignore file
-  $ bearer ignore add <fingerprint> --author Mish --comment "Possible false positive"
+    # Add an ignored fingerprint to your ignore file
+    $ bearer ignore add <fingerprint> --author Mish --comment "Possible false positive"
 see_also:
-  - bearer ignore - Manage ignored fingerprints
-aliases:
+    - bearer ignore - Manage ignored fingerprints
diff --git a/docs/_data/bearer_ignore_migrate.yaml b/docs/_data/bearer_ignore_migrate.yaml
@@ -2,45 +2,47 @@ name: bearer ignore migrate
 synopsis: Migrate ignored fingerprints from bearer.yml to ignore file
 usage: bearer ignore migrate [flags]
 options:
-  - name: api-key
-    usage: Use your Bearer API Key to send the report to Bearer.
-  - name: config-file
-    default_value: bearer.yml
-    usage: Load configuration from the specified path.
-  - name: debug
-    default_value: "false"
-    usage: Enable debug logs. Equivalent to --log-level=debug
-  - name: debug-profile
-    default_value: "false"
-    usage: Generate profiling data for debugging
-  - name: disable-version-check
-    default_value: "false"
-    usage: Disable Bearer version checking
-  - name: force
-    default_value: "false"
-    usage: Overwrite an existing ignored finding.
-  - name: help
-    shorthand: h
-    default_value: "false"
-    usage: help for migrate
-  - name: host
-    default_value: my.bearer.sh
-    usage: Specify the Host for sending the report.
-  - name: ignore-file
-    default_value: bearer.ignore
-    usage: Load ignore file from the specified path.
-  - name: ignore-git
-    default_value: "false"
-    usage: Ignore Git listing
-  - name: log-level
-    default_value: info
-    usage: Set log level (error, info, debug, trace)
-  - name: no-color
-    default_value: "false"
-    usage: Disable color in output
+    - name: config-file
+      default_value: bearer.yml
+      usage: Load configuration from the specified path.
+      environment_variables:
+        - BEARER_CONFIG_FILE
+    - name: debug
+      default_value: "false"
+      usage: Enable debug logs. Equivalent to --log-level=debug
+      environment_variables:
+        - BEARER_DEBUG
+    - name: disable-version-check
+      default_value: "false"
+      usage: Disable Bearer version checking
+      environment_variables:
+        - BEARER_DISABLE_VERSION_CHECK
+    - name: force
+      default_value: "false"
+      usage: Overwrite an existing ignored finding.
+      environment_variables:
+        - BEARER_FORCE
+    - name: help
+      shorthand: h
+      default_value: "false"
+      usage: help for migrate
+    - name: ignore-file
+      default_value: bearer.ignore
+      usage: Load ignore file from the specified path.
+      environment_variables:
+        - BEARER_IGNORE_FILE
+    - name: log-level
+      default_value: info
+      usage: Set log level (error, info, debug, trace)
+      environment_variables:
+        - BEARER_LOG_LEVEL
+    - name: no-color
+      default_value: "false"
+      usage: Disable color in output
+      environment_variables:
+        - BEARER_NO_COLOR
 example: |-
-  # Migrate existing ignored (excluded) fingerprints from bearer.yml file to ignore file
-  $ bearer ignore migrate
+    # Migrate existing ignored (excluded) fingerprints from bearer.yml file to ignore file
+    $ bearer ignore migrate
 see_also:
-  - bearer ignore - Manage ignored fingerprints
-aliases:
+    - bearer ignore - Manage ignored fingerprints
diff --git a/docs/_data/bearer_ignore_pull.yaml b/docs/_data/bearer_ignore_pull.yaml
@@ -2,42 +2,42 @@ name: bearer ignore pull
 synopsis: Pull ignored fingerprints from Cloud
 usage: bearer ignore pull <path> [flags]
 options:
-  - name: api-key
-    usage: Use your Bearer API Key to send the report to Bearer.
-  - name: config-file
-    default_value: bearer.yml
-    usage: Load configuration from the specified path.
-  - name: debug
-    default_value: "false"
-    usage: Enable debug logs. Equivalent to --log-level=debug
-  - name: debug-profile
-    default_value: "false"
-    usage: Generate profiling data for debugging
-  - name: disable-version-check
-    default_value: "false"
-    usage: Disable Bearer version checking
-  - name: help
-    shorthand: h
-    default_value: "false"
-    usage: help for pull
-  - name: host
-    default_value: my.bearer.sh
-    usage: Specify the Host for sending the report.
-  - name: ignore-file
-    default_value: bearer.ignore
-    usage: Load ignore file from the specified path.
-  - name: ignore-git
-    default_value: "false"
-    usage: Ignore Git listing
-  - name: log-level
-    default_value: info
-    usage: Set log level (error, info, debug, trace)
-  - name: no-color
-    default_value: "false"
-    usage: Disable color in output
+    - name: config-file
+      default_value: bearer.yml
+      usage: Load configuration from the specified path.
+      environment_variables:
+        - BEARER_CONFIG_FILE
+    - name: debug
+      default_value: "false"
+      usage: Enable debug logs. Equivalent to --log-level=debug
+      environment_variables:
+        - BEARER_DEBUG
+    - name: disable-version-check
+      default_value: "false"
+      usage: Disable Bearer version checking
+      environment_variables:
+        - BEARER_DISABLE_VERSION_CHECK
+    - name: help
+      shorthand: h
+      default_value: "false"
+      usage: help for pull
+    - name: ignore-file
+      default_value: bearer.ignore
+      usage: Load ignore file from the specified path.
+      environment_variables:
+        - BEARER_IGNORE_FILE
+    - name: log-level
+      default_value: info
+      usage: Set log level (error, info, debug, trace)
+      environment_variables:
+        - BEARER_LOG_LEVEL
+    - name: no-color
+      default_value: "false"
+      usage: Disable color in output
+      environment_variables:
+        - BEARER_NO_COLOR
 example: |-
-  # Pull ignored fingerprints from the Cloud (requires API key)
-  $ bearer ignore pull /path/to/your_project --api-key=XXXXX
+    # Pull ignored fingerprints from the Cloud (requires API key)
+    $ bearer ignore pull /path/to/your_project --api-key=XXXXX
 see_also:
-  - bearer ignore - Manage ignored fingerprints
-aliases:
+    - bearer ignore - Manage ignored fingerprints
diff --git a/docs/_data/bearer_ignore_remove.yaml b/docs/_data/bearer_ignore_remove.yaml
@@ -2,42 +2,42 @@ name: bearer ignore remove
 synopsis: Remove an ignored fingerprint
 usage: bearer ignore remove <fingerprint> [flags]
 options:
-  - name: api-key
-    usage: Use your Bearer API Key to send the report to Bearer.
-  - name: config-file
-    default_value: bearer.yml
-    usage: Load configuration from the specified path.
-  - name: debug
-    default_value: "false"
-    usage: Enable debug logs. Equivalent to --log-level=debug
-  - name: debug-profile
-    default_value: "false"
-    usage: Generate profiling data for debugging
-  - name: disable-version-check
-    default_value: "false"
-    usage: Disable Bearer version checking
-  - name: help
-    shorthand: h
-    default_value: "false"
-    usage: help for remove
-  - name: host
-    default_value: my.bearer.sh
-    usage: Specify the Host for sending the report.
-  - name: ignore-file
-    default_value: bearer.ignore
-    usage: Load ignore file from the specified path.
-  - name: ignore-git
-    default_value: "false"
-    usage: Ignore Git listing
-  - name: log-level
-    default_value: info
-    usage: Set log level (error, info, debug, trace)
-  - name: no-color
-    default_value: "false"
-    usage: Disable color in output
+    - name: config-file
+      default_value: bearer.yml
+      usage: Load configuration from the specified path.
+      environment_variables:
+        - BEARER_CONFIG_FILE
+    - name: debug
+      default_value: "false"
+      usage: Enable debug logs. Equivalent to --log-level=debug
+      environment_variables:
+        - BEARER_DEBUG
+    - name: disable-version-check
+      default_value: "false"
+      usage: Disable Bearer version checking
+      environment_variables:
+        - BEARER_DISABLE_VERSION_CHECK
+    - name: help
+      shorthand: h
+      default_value: "false"
+      usage: help for remove
+    - name: ignore-file
+      default_value: bearer.ignore
+      usage: Load ignore file from the specified path.
+      environment_variables:
+        - BEARER_IGNORE_FILE
+    - name: log-level
+      default_value: info
+      usage: Set log level (error, info, debug, trace)
+      environment_variables:
+        - BEARER_LOG_LEVEL
+    - name: no-color
+      default_value: "false"
+      usage: Disable color in output
+      environment_variables:
+        - BEARER_NO_COLOR
 example: |-
-  # Remove an ignored fingerprint from your ignore file
-  $ bearer ignore remove <fingerprint>
+    # Remove an ignored fingerprint from your ignore file
+    $ bearer ignore remove <fingerprint>
 see_also:
-  - bearer ignore - Manage ignored fingerprints
-aliases:
+    - bearer ignore - Manage ignored fingerprints