prb soa command reference
Reference for 12 commands under prb soa, including usage, flag types and defaults, required flags, source examples, and implementation links
Manage statements of applicability. This page documents 12 commands under prb soa.
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 soa | Manage statements of applicability. | prb soa <command> | View implementation |
prb soa create | Create a new statement of applicability. | prb soa create | View implementation |
prb soa delete | Delete a statement of applicability. | prb soa delete <id> | View implementation |
prb soa list | List statements of applicability. | prb soa list | View implementation |
prb soa publish | Publish a statement of applicability as a document version. | prb soa publish <soa-id> | View implementation |
prb soa statement | Manage applicability statements in a SoA. | prb soa statement <command> | View implementation |
prb soa statement add | Add an applicability statement to a SoA. | prb soa statement add | View implementation |
prb soa statement list | List applicability statements in a SoA. | prb soa statement list <soa-id> | View implementation |
prb soa statement remove | Remove an applicability statement from a SoA. | prb soa statement remove <id> | View implementation |
prb soa statement update | Update an applicability statement. | prb soa statement update <id> | View implementation |
prb soa update | Update a statement of applicability. | prb soa update <id> | View implementation |
prb soa view | View a statement of applicability. | prb soa view <id> | View implementation |
prb soa
Section titled “prb soa”Manage statements of applicability.
prb soa <command>prb soa create
Section titled “prb soa create”Create a new statement of applicability.
prb soa createAccepts no positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--name | string | "" | Required | Name (required) |
--org | string | "" | — | Organization ID |
Examples
Section titled “Examples”# Create a statement of applicabilityprb soa create --name "ISO 27001 SoA"prb soa delete
Section titled “prb soa delete”Delete a statement of applicability.
prb soa delete <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--yes, -y | boolean | false | — | Skip confirmation prompt |
prb soa list
Section titled “prb soa list”List statements of applicability.
prb soa listAccepts no positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--after | string | "" | — | Cursor from the previous page (the Next cursor line) |
--json | boolean | false | — | Output JSON (same as —output json) |
--limit, -L | integer | 30 | — | Maximum number of items to list |
--order-by | string | "" | — | Order by field (NAME, CREATED_AT) |
--order-direction | string | "DESC" | — | Sort direction (ASC, DESC) |
--org | string | "" | — | Organization ID |
--output, -o | string | "" | — | Output format: json, table (default) |
prb soa publish
Section titled “prb soa publish”Publish a statement of applicability as a document version.
prb soa publish <soa-id>Requires 1 positional argument.
| 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) |
Examples
Section titled “Examples”# Publish an SOAprb soa publish SOA_ID
# Publish with approversprb soa publish SOA_ID --approver PROFILE_ID1 --approver PROFILE_ID2prb soa statement
Section titled “prb soa statement”Manage applicability statements in a SoA.
prb soa statement <command>prb soa statement add
Section titled “prb soa statement add”Add an applicability statement to a SoA.
prb soa statement addAccepts no positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--applicable | boolean | false | — | Mark control as applicable |
--control | string | "" | Required | Control ID (required) |
--justification | string | "" | — | Justification for the applicability decision |
--not-applicable | boolean | false | — | Mark control as not applicable |
--soa | string | "" | Required | Statement of applicability ID (required) |
Examples
Section titled “Examples”# Add a control as applicableprb soa statement add --soa SOA_ID --control CTRL_ID --applicable
# Add a control as not applicable with justificationprb soa statement add --soa SOA_ID --control CTRL_ID --not-applicable --justification "Not in scope"prb soa statement list
Section titled “prb soa statement list”List applicability statements in a SoA.
prb soa statement list <soa-id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--after | string | "" | — | Cursor from the previous page (the Next cursor line) |
--json | boolean | false | — | Output JSON (same as —output json) |
--limit, -L | integer | 30 | — | Maximum number of statements to list |
--order-by | string | "" | — | Order by field (CREATED_AT, CONTROL_SECTION_TITLE) |
--order-direction | string | "DESC" | — | Sort direction (ASC, DESC) |
--output, -o | string | "" | — | Output format: json, table (default) |
prb soa statement remove
Section titled “prb soa statement remove”Remove an applicability statement from a SoA.
prb soa statement remove <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--yes, -y | boolean | false | — | Skip confirmation prompt |
prb soa statement update
Section titled “prb soa statement update”Update an applicability statement.
prb soa statement update <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--applicable | boolean | false | — | Mark control as applicable |
--justification | string | "" | — | Justification for the applicability decision |
--not-applicable | boolean | false | — | Mark control as not applicable |
prb soa update
Section titled “prb soa update”Update a statement of applicability.
prb soa update <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--name | string | "" | — | Name |
prb soa view
Section titled “prb soa view”View a statement of applicability.
prb soa 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) |