prb risk command reference
Reference for 7 commands under prb risk, including usage, flag types and defaults, required flags, source examples, and implementation links
Manage risks. This page documents 7 commands under prb risk.
Flags and examples below come from the command definitions. A Required flag is explicitly marked required by Cobra; an unmarked flag can still be needed by runtime validation or a non-interactive workflow. Empty strings and empty lists are registered defaults, not sample values.
Every command also inherits the global flags. Run prb <command> --help to check your installed version. Replace placeholder IDs and names in source examples before running them. Return to the complete CLI command reference to browse another command.
Commands
Section titled “Commands”| Command | Description | Usage | Source |
|---|---|---|---|
prb risk | Manage risks. | prb risk <command> | View implementation |
prb risk create | Create a new risk. | prb risk create | View implementation |
prb risk delete | Delete a risk and its analysis history. | prb risk delete <id> | View implementation |
prb risk list | List risks in an organization or unplanned risks on an analysis. | prb risk list | View implementation |
prb risk publish | Publish the risk register as a document version. | prb risk publish | View implementation |
prb risk update | Update a risk. | prb risk update <id> | View implementation |
prb risk view | View a risk. | prb risk view <id> | View implementation |
prb risk
Section titled “prb risk”Manage risks.
prb risk <command>prb risk create
Section titled “prb risk create”Create a new risk.
prb risk create| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--category | string | "" | — | Risk category (required) |
--description | string | "" | — | Risk description |
--name | string | "" | — | Risk name (required) |
--note | string | "" | — | Risk note |
--org | string | "" | — | Organization ID |
Examples
Section titled “Examples”# Create a risk interactivelyprb risk create
# Create a risk non-interactivelyprb risk create --name "Data breach" --category "Security"prb risk delete
Section titled “prb risk delete”Delete a risk and its analysis history.
prb risk delete <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--yes, -y | boolean | false | — | Skip confirmation prompt |
prb risk list
Section titled “prb risk list”List risks in an organization or unplanned risks on an analysis.
prb risk listAccepts no positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--after | string | "" | — | Cursor from the previous page (the Next cursor line) |
--filter, -q | string | "" | — | Filter risks by search query |
--json | boolean | false | — | Output JSON (same as —output json) |
--limit, -L | integer | 30 | — | Maximum number of risks to list |
--order-by | string | "" | — | Order by field (CREATED_AT, REFERENCE_ID, NAME, CATEGORY, TREATMENT, INHERENT_RISK_SCORE, RESIDUAL_RISK_SCORE) |
--order-direction | string | "DESC" | — | Sort direction (ASC, DESC) |
--org | string | "" | — | Organization ID |
--output, -o | string | "" | — | Output format: json, table (default) |
--risk-analysis | string | "" | — | List unplanned scenario-linked risks on a risk analysis |
Examples
Section titled “Examples”# List risks in the default organizationprb risk list
# Filter risks by nameprb risk list --filter "data breach"
# List unplanned scenario-linked risks on an analysisprb risk ls --risk-analysis <id>
# List risks sorted by inherent scoreprb risk ls --order-by INHERENT_RISK_SCORE --output jsonprb risk publish
Section titled “prb risk publish”Publish the risk register as a document version.
prb risk publish| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--approver | string array | [] | — | Approver profile ID (can be repeated; ignored with —minor) |
--minor | boolean | false | — | Publish as a minor version (no approval flow) |
--org | string | "" | — | Organization ID |
Examples
Section titled “Examples”# Publish the risk registerprb risk publish --org ORG_ID
# Publish with approversprb risk publish --org ORG_ID --approver PROFILE_ID1 --approver PROFILE_ID2prb risk update
Section titled “prb risk update”Update a risk.
prb risk update <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--category | string | "" | — | Risk category |
--description | string | "" | — | Risk description |
--name | string | "" | — | Risk name |
--note | string | "" | — | Risk note |
prb risk view
Section titled “prb risk view”View a risk.
prb risk view <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--json | boolean | false | — | Output JSON (same as —output json) |
--output, -o | string | "" | — | Output format: json, table (default) |