Skip to content

Commit

Permalink
docs: update diff docs
Browse files Browse the repository at this point in the history
  • Loading branch information
didroe committed Nov 21, 2023
1 parent 7dd9e16 commit f475a35
Show file tree
Hide file tree
Showing 14 changed files with 402 additions and 384 deletions.
20 changes: 10 additions & 10 deletions docs/_data/bearer.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
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
aliases:
12 changes: 6 additions & 6 deletions docs/_data/bearer_completion.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ 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 - '
aliases:
98 changes: 49 additions & 49 deletions docs/_data/bearer_ignore_add.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,54 +2,54 @@ 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: 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
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
aliases:
80 changes: 40 additions & 40 deletions docs/_data/bearer_ignore_migrate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,45 @@ 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: 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
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
aliases:
74 changes: 37 additions & 37 deletions docs/_data/bearer_ignore_pull.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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: 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
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
aliases:
74 changes: 37 additions & 37 deletions docs/_data/bearer_ignore_remove.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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: 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
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
aliases:
Loading

0 comments on commit f475a35

Please sign in to comment.