Bevor Docs | Harness your smart contract security

Manage analyses.

`create`

Create a root analysis for the configured code version.

bevor analysis create [OPTIONS]

Arguments:

--nametext

Optional analysis name.

--collisionchoice

default:surface

What Bevor should do if analysis already exists for the given code

--yesboolean

Skip confirmation of action.

--jsonboolean

JSON output

--forceboolean

Skip checks. Not recommended.

`use`

Update the configured analysis.

bevor analysis use [OPTIONS]

Arguments:

analysis_idtextrequired

Analysis container id.

`set`

Move the analysis HEAD to version_id. This will change which analysis versions you act on.

bevor analysis set [OPTIONS]

Arguments:

version_idtextrequired

Analysis version id to set as HEAD.

`get`

Print details for the configured analysis head (or --version). Can be used similarly to bevor analysis current.

bevor analysis get [OPTIONS]

Arguments:

--versiontext

Act on this analysis version id instead of the configured analysis head.

--jsonboolean

JSON output

`recent`

Retrieve the most recent active analysis for the user

bevor analysis recent [OPTIONS]

Arguments:

--jsonboolean

JSON output

`current`

Get details of currently configured analysis

bevor analysis current [OPTIONS]

Arguments:

--jsonboolean

JSON output

`list`

List analyses for the configured project, or use the --project flag to list for a specific project, or pass the --all flag to list analyses across all projects in the configured team.

bevor analysis 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 (defaults to .bevor config).

--usertext

Analysis creator to filter by

--is-ownerboolean

Analysis filter by owner only

--jsonboolean

JSON output

--allboolean

List analyses for all projects in current team

`run`

Start a run of Bevor Security pipeline for the configured analysis head (or --version).

bevor analysis run [OPTIONS]

Arguments:

--versiontext

Version id to run (default: configured analysis head).

--no-waitboolean

Return immediately without waiting for the event stream to complete.

--silentboolean

Suppress intermediate output logs.

`retry`

Retry failed segments of a Bevor Security pipeline run for the configured analysis head (or --version). See bevor analysis run.

bevor analysis retry [OPTIONS]

Arguments:

--versiontext

Version id to retry (default: configured analysis head).

--no-waitboolean

Return immediately without waiting for the event stream to complete.

--silentboolean

Suppress intermediate output logs.

`diff`

Show finding diffs for the configured analysis head (or --version). --staged flag will show the diff of the staged commits. Excluding it, it'll show the diff of committed findings between the analysis and its parent.

bevor analysis diff [OPTIONS]

Arguments:

--versiontext

Version id to diff (default: configured analysis head).

--stagedboolean

Show staged drafts instead of version-vs-parent diffs.

--jsonboolean

JSON output

`commit`

Commit staged findings for an analysis. This will update the HEAD of the configured analysis, or of the analysis associated to the --version.

bevor analysis commit [OPTIONS]

Arguments:

--versiontext

Version id to commit (default: configured analysis head).

`child`

Create a child analysis version using the configured code. If there is no currently configured analysis (bevor context or bevor analysis current), you can pass a --version, or you can link an analysis using bevor analysis use. Bevor will check whether an analysis exists for the given code version or not, and early return if so. Use the --collision argument to bypass this, but it's advised not to.

bevor analysis child [OPTIONS]

Arguments:

--versiontext

Parent version id (default: configured analysis head).

--collisionchoice

default:surface

What Bevor should do if analysis already exists for the given code

`fork`

Fork an analysis version and set the new analysis as configured.

bevor analysis fork [OPTIONS]

Arguments:

--versiontext

Version id to fork (default: configured analysis head).

`merge`

Merge one analysis into another. --from is required, but --to defaults to your active analysis's HEAD. This will create a child analysis version of the --to, and update its HEAD.

bevor analysis merge [OPTIONS]

Arguments:

from_analysistextrequired

Source analysis container id.

--totext

Destination analysis container id.

`findings`

List findings on the configured analysis, or --version. Including a --sarif path will output the findings into a SARIF format. --interactive will open an interactive terminal to explore further.

bevor analysis findings [OPTIONS]

Arguments:

--versiontext

Version id to list findings for (default: configured analysis head).

--interactiveboolean

Browse findings and expand the focused row.

--jsonboolean

JSON output

--sarifpath

Write SARIF for the configured analysis to this path.

`entrypoints`

List entrypoints for the configured analysis head (or --version).

bevor analysis entrypoints [OPTIONS]

Arguments:

--versiontext

Version id (default: configured analysis head).

--jsonboolean

JSON output

`remediations`

List remediated findings for the configured analysis head (or --version). By default it'll list remediations for your currently configured analysis, but you can override this with --version, or you can pass --project which will list remediations across an entire project instead.

bevor analysis remediations [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 to filter by. Defaults to current configuration

--versiontext

Version id (default: configured analysis head).

--jsonboolean

JSON output

`delete`

Delete an analysis container or version.

`full`

Delete the entire currently configured analysis container

bevor analysis delete full [OPTIONS]

`version`

Delete a single analysis version (leaf).

bevor analysis delete version [OPTIONS]

Arguments:

versiontext

Version id to delete (default: configured analysis head).

analysis

create

use

set

get

recent

current

list

run

retry

diff

commit

child

fork

merge

findings

entrypoints

remediations

delete

full

version

On this page

`create`

`use`

`set`

`get`

`recent`

`current`

`list`

`run`

`retry`

`diff`

`commit`

`child`

`fork`

`merge`

`findings`

`entrypoints`

`remediations`

`delete`

`full`

`version`