prb finding command reference
Reference for 7 commands under prb finding, including usage, flag types and defaults, required flags, source examples, and implementation links
Manage findings. This page documents 7 commands under prb finding.
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 finding | Manage findings. | prb finding <command> | View implementation |
prb finding create | Create a new finding. | prb finding create | View implementation |
prb finding delete | Delete a finding. | prb finding delete <id> | View implementation |
prb finding list | List findings in an organization. | prb finding list | View implementation |
prb finding publish | Publish the finding register as a document version. | prb finding publish | View implementation |
prb finding update | Update a finding. | prb finding update <id> | View implementation |
prb finding view | View a finding. | prb finding view <id> | View implementation |
prb finding
Section titled “prb finding”Manage findings.
prb finding <command>prb finding create
Section titled “prb finding create”Create a new finding.
prb finding createAccepts no positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--corrective-action | string | "" | — | Corrective action |
--description | string | "" | — | Finding description |
--due-date | string | "" | — | Due date (RFC3339) |
--effectiveness-check | string | "" | — | Effectiveness check |
--identified-on | string | "" | — | Date identified (RFC3339) |
--kind | string | "" | Required | Finding kind: MINOR_NONCONFORMITY, MAJOR_NONCONFORMITY, OBSERVATION, EXCEPTION (required) |
--org | string | "" | — | Organization ID |
--owner-id | string | "" | — | Owner profile ID |
--priority | string | "" | Required | Priority: LOW, MEDIUM, HIGH (required) |
--risk-id | string | "" | — | Associated risk ID |
--root-cause | string | "" | — | Root cause |
--source | string | "" | — | Finding source |
--status | string | "" | Required | Status: OPEN, IN_PROGRESS, CLOSED, RISK_ACCEPTED, MITIGATED, FALSE_POSITIVE (required) |
Examples
Section titled “Examples”# Create a findingprb finding create --org ORG_ID --kind MINOR_NONCONFORMITY --owner-id OWNER_ID --status OPEN --priority HIGHprb finding delete
Section titled “prb finding delete”Delete a finding.
prb finding delete <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--yes, -y | boolean | false | — | Skip confirmation prompt |
prb finding list
Section titled “prb finding list”List findings in an organization.
prb finding listAccepts no positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--after | string | "" | — | Cursor from the previous page (the Next cursor line) |
--audit | string | "" | — | Filter by audit ID |
--json | boolean | false | — | Output JSON (same as —output json) |
--kind | string | "" | — | Filter by kind (MINOR_NONCONFORMITY, MAJOR_NONCONFORMITY, OBSERVATION, EXCEPTION) |
--limit, -L | integer | 30 | — | Maximum number of findings to list |
--order-by | string | "" | — | Order by field (CREATED_AT, REFERENCE_ID, IDENTIFIED_ON, DUE_DATE, STATUS, PRIORITY, KIND) |
--order-direction | string | "DESC" | — | Sort direction (ASC, DESC) |
--org | string | "" | — | Organization ID |
--output, -o | string | "" | — | Output format: json, table (default) |
Examples
Section titled “Examples”# List findings in an organizationprb finding list --org <organization-id>
# Filter by kind and output as JSONprb finding ls --org <organization-id> --kind MINOR_NONCONFORMITY --output json
# List findings linked to an auditprb finding ls --org <organization-id> --audit <audit-id>prb finding publish
Section titled “prb finding publish”Publish the finding register as a document version.
prb finding 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 finding registerprb finding publish --org ORG_ID
# Publish with approversprb finding publish --org ORG_ID --approver PROFILE_ID1 --approver PROFILE_ID2prb finding update
Section titled “prb finding update”Update a finding.
prb finding update <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--corrective-action | string | "" | — | Corrective action |
--description | string | "" | — | Finding description |
--due-date | string | "" | — | Due date (RFC3339) |
--effectiveness-check | string | "" | — | Effectiveness check |
--identified-on | string | "" | — | Date identified (RFC3339) |
--owner-id | string | "" | — | Owner profile ID |
--priority | string | "" | — | Priority: LOW, MEDIUM, HIGH |
--risk-id | string | "" | — | Associated risk ID |
--root-cause | string | "" | — | Root cause |
--source | string | "" | — | Finding source |
--status | string | "" | — | Status: OPEN, IN_PROGRESS, CLOSED, RISK_ACCEPTED, MITIGATED, FALSE_POSITIVE |
prb finding view
Section titled “prb finding view”View a finding.
prb finding 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) |