Skip to content

Commit

Permalink
docs: update command data files for updated general flags
Browse files Browse the repository at this point in the history
  • Loading branch information
elsapet committed Aug 28, 2023
1 parent 8313e98 commit f075374
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/_data/bearer_ignore_add.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ name: ' ignore add'
synopsis: Add an ignored fingerprint
usage: ' 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.
Expand All @@ -10,13 +12,28 @@ options:
usage: Load bearer.ignore file from the specified path.
- 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-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 add
- name: host
default_value: my.bearer.sh
usage: Specify the Host for sending the report.
- name: no-color
default_value: "false"
usage: Disable color in output
example: |-
# Add an ignored fingerprint to your bearer.ignore file
$ bearer ignore add <fingerprint> --author Mish --comment "Possible false positive"
Expand Down
14 changes: 14 additions & 0 deletions docs/_data/bearer_ignore_migrate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,33 @@ synopsis: |
Migrate ignored fingerprints from bearer.yml to bearer.ignore
usage: ' ignore migrate [flags]'
options:
- name: api-key
usage: Use your Bearer API Key to send the report to Bearer.
- name: bearer-ignore-file
default_value: bearer.ignore
usage: Load bearer.ignore file from the specified path.
- name: config-file
default_value: bearer.yml
usage: Load configuration from the specified path.
- 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: no-color
default_value: "false"
usage: Disable color in output
example: |-
# Migrate existing ignored (excluded) fingerprints from bearer.yml file to bearer.ignore
$ bearer ignore migrate
Expand Down
17 changes: 17 additions & 0 deletions docs/_data/bearer_ignore_remove.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,30 @@ name: ' ignore remove'
synopsis: Remove an ignored fingerprint
usage: ' ignore remove <fingerprint> [flags]'
options:
- name: api-key
usage: Use your Bearer API Key to send the report to Bearer.
- name: bearer-ignore-file
default_value: bearer.ignore
usage: Load bearer.ignore file from the specified path.
- name: config-file
default_value: bearer.yml
usage: Load configuration from the specified path.
- 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: no-color
default_value: "false"
usage: Disable color in output
example: |-
# Remove an ignored fingerprint from your bearer.ignore file
$ bearer ignore remove <fingerprint>
Expand Down
17 changes: 17 additions & 0 deletions docs/_data/bearer_ignore_show.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,30 @@ options:
- name: all
default_value: "false"
usage: Show all ignored fingerprints.
- name: api-key
usage: Use your Bearer API Key to send the report to Bearer.
- name: bearer-ignore-file
default_value: bearer.ignore
usage: Load bearer.ignore file from the specified path.
- name: config-file
default_value: bearer.yml
usage: Load configuration from the specified path.
- 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 show
- name: host
default_value: my.bearer.sh
usage: Specify the Host for sending the report.
- name: no-color
default_value: "false"
usage: Disable color in output
example: |-
# Show the details of an ignored fingerprint from your bearer.ignore file
$ bearer ignore show <fingerprint>
Expand Down

0 comments on commit f075374

Please sign in to comment.