Skip to content

av project

Manage AlertaVuln projects - the unit that repos, scan findings, and alert settings attach to.

Terminal window
av project <command> [flags]

The binary ships as alertavuln; av is the common alias - they are interchangeable in every example.

av project groups four subcommands: list, create, get, and delete. Every subcommand requires a login token - run av login first - and operates against the organisation your token is scoped to (see av org switch).

List all projects.

Terminal window
av project list

list takes no flags. It prints one row per project with the columns ID, NAME, MIN SEVERITY, and CREATED. Use the ID value anywhere a project ID is expected - av project get, av project delete, or av sast scan --project.

List the projects in the active organisation:

Terminal window
av project list

Create a new project.

Terminal window
av project create --name <name> [flags]

On success the command prints the new project’s name and ID.

Flag Default Description
--name - Project name (required)
--description - Project description

Create a project with just a name:

Terminal window
av project create --name payments-api

Add a description so teammates know what the project covers:

Terminal window
av project create --name payments-api --description "Payment gateway services"

Show project details as JSON.

Terminal window
av project get <id>

get takes the project ID as its single argument and prints the full project record - id, name, description, minSeverityThreshold, staleThresholdDays, createdAt, updatedAt - as indented JSON, which makes it the right subcommand for scripting.

Inspect a project:

Terminal window
av project get 3f9d2c81-0b7a-4e5d-9c1f-6a2e8b4d7f10

Extract a single field with jq:

Terminal window
av project get 3f9d2c81-0b7a-4e5d-9c1f-6a2e8b4d7f10 | jq -r .minSeverityThreshold

Delete a project.

Terminal window
av project delete <id>

delete takes the project ID as its single argument and prints a confirmation line once the project is gone.

Delete a project by ID:

Terminal window
av project delete 3f9d2c81-0b7a-4e5d-9c1f-6a2e8b4d7f10
Code Meaning
0 Command completed successfully
1 Any failure - not logged in, project not found, or API error
  • av org - manage organisations and switch the active one
  • av sast scan - upload scan findings to a project with --project