finding

Findings for the configured analysis.

list

Search findings across the currently configured project, or the --project, or search across the entire team by using --all.

bevor finding list [OPTIONS]

Arguments:

--pageinteger

Page number to use for resource that supports pagination

--page-sizeinteger

Page size to use for resource that supports pagination

--orderchoice

How to order results when a resource supports pagination

--order-bychoice

What field to order results by when a resource supports pagination

--projecttext

Project id to filter by.

--selfboolean

Filter by findings in analyses the caller owns.

--usertext

Filter by user id (user who owns the analysis the finding is in)

--codetext

Code Id to filter by.

--analysestext

Analysis ids to filter by (comma separated)

--typechoice

Finding type.

--levelchoice

Finding level.

--acknowledgedboolean

Filter by acknowledgement status.

--operationchoice

Staged draft operation.

--created-by-selfboolean

Filter by findings the caller is original creator of

--created-bytext

Filter by original creator of a finding.

--allboolean

Show findings across all projects

--jsonboolean

JSON output

get

Get the finding details.

bevor finding get [OPTIONS]

Arguments:

finding_idtextrequired

Finding ID.

--jsonboolean

JSON output

add

Stage a new finding to your currently configured analysis, or to the --version.

Provide input one of three ways:

  • --file: a YAML file with exactly one finding mapping.
  • --interactive: prompts for each field.
  • Flags directly, as described below.

When passing flags, specify a location, which specifies the code node that the finding is associated with, using exactly one of:

  • --node and/or --location (a Bevor node id; --location alone fans the finding out to every entrypoint that reaches it)
  • --uri plus one full pair of --start-line/--end-line, --char-offset/--char-length, or --byte-offset/--byte-length
  • --fqn

Metadata (--type, --level, --name, --explanation) is all or nothing: provide all four to record a finding, or omit all four to mark the location as analyzed with no finding. --recommendation, --reference, and --source are always optional.

bevor finding add [OPTIONS]

Arguments:

--versiontext

Version id to stage against (default: configured analysis head).

--filepath

YAML file containing exactly one finding mapping.

--interactiveboolean

Force interactive prompts.

--typetext
--levelchoice
--nametext
--explanationtext
--recommendationtext
--referencetext
--sourcetext
--nodetext
--locationtext
--uritext
--start-lineinteger
--start-columninteger
--end-lineinteger
--end-columninteger
--char-offsetinteger
--char-lengthinteger
--byte-offsetinteger
--byte-lengthinteger
--fqntext

bulk

Import many findings at once to the configured analysis head, or --version if given

source is dispatched by type:

  • a directory: every .yaml/.yml file in it is parsed, each of which may itself contain multiple findings (----separated documents).
  • a .yaml/.yml file: parsed the same way, as a single source.
  • a .sarif file: converted from SARIF into Bevor findings.
bevor finding bulk [OPTIONS]

Arguments:

sourcepathrequired

A .json file, .sarif file, .yaml/.yml file, or a directory of YAML files.

--versiontext

Version id to stage against (default: configured analysis head).

edit

Stage an edit to a finding (--file YAML or interactive matching current metadata).

bevor finding edit [OPTIONS]

Arguments:

finding_idtextrequired

Finding id to edit.

--file, -fpath

YAML with one mapping: type, level, name, explanation; optional recommendation / reference.

delete

Stage a finding deletion.

bevor finding delete [OPTIONS]

Arguments:

finding_idtextrequired

Finding id to delete.

revert

Revert a staged finding change.

bevor finding revert [OPTIONS]

Arguments:

finding_idtextrequired

Finding id to revert.

acknowledge

Toggle acknowledgement status for a finding.

bevor finding acknowledge [OPTIONS]

Arguments:

finding_idtextrequired

Finding id to toggle validation for.

On this page