Skip to content

Suggested searches

    Search all documentation ↑↓ to navigate Enter to open Esc to close

    prb document command reference

    Reference for 19 commands under prb document, including usage, flag types and defaults, required flags, source examples, and implementation links

    Markdown

    Manage documents. This page documents 19 commands under prb document.

    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.

    CommandDescriptionUsageSource
    prb documentManage documents.prb document <command>View implementation
    prb document archiveArchive a document.prb document archive <id>View implementation
    prb document createCreate a new document.prb document createView implementation
    prb document deleteDelete a document.prb document delete <id>View implementation
    prb document delete-draftDelete the draft version of a document.prb document delete-draft <document-id>View implementation
    prb document listList documents in an organization.prb document listView implementation
    prb document list-approval-decisionsList approval decisions for a quorum.prb document list-approval-decisions <quorum-id>View implementation
    prb document list-approval-quorumsList approval quorums for a document version.prb document list-approval-quorums <document-version-id>View implementation
    prb document list-historyList revisions for a document.prb document list-history <document-id>View implementation
    prb document list-versionsList versions of a document.prb document list-versions <document-id>View implementation
    prb document publishPublish a document.prb document publish <document-id>View implementation
    prb document restore-historyRestore a draft document to a collaboration history point.prb document restore-history <document-id>View implementation
    prb document unarchiveUnarchive a document.prb document unarchive <id>View implementation
    prb document updateUpdate a document.prb document update <id>View implementation
    prb document viewView a document.prb document view <id>View implementation
    prb document view-approval-decisionView an approval decision.prb document view-approval-decision <id>View implementation
    prb document view-approval-quorumView an approval quorum.prb document view-approval-quorum <id>View implementation
    prb document view-history-snapshotView the content and edit highlights of a revision.prb document view-history-snapshot <document-id> <revision-id>View implementation
    prb document view-versionView a document version.prb document view-version <id>View implementation

    Manage documents.

    prb document <command>

    View command implementation.

    Archive a document.

    prb document archive <id>

    Requires 1 positional argument.

    View command implementation.

    Create a new document.

    prb document create

    Accepts no positional arguments.

    FlagTypeDefaultRequiredDescription
    --classificationstring""—Classification: PUBLIC, INTERNAL, CONFIDENTIAL, SECRET
    --contentstring""—Document content as markdown or ProseMirror JSON. Images and links to /api/files/v1/{id} are kept
    --document-typestring""—Document type: OTHER, GOVERNANCE, POLICY, PROCEDURE, PLAN, REGISTER, RECORD, REPORT, TEMPLATE
    --orgstring""—Organization ID
    --titlestring""—Document title
    Terminal window
    # Create a policy document
    prb document create --title "Information Security Policy" --document-type POLICY --classification INTERNAL
    # Create a document interactively
    prb document create

    View command implementation.

    Delete a document.

    prb document delete <id>

    Requires 1 positional argument.

    FlagTypeDefaultRequiredDescription
    --yes, -ybooleanfalse—Skip confirmation prompt

    View command implementation.

    Delete the draft version of a document.

    prb document delete-draft <document-id>

    Requires 1 positional argument.

    FlagTypeDefaultRequiredDescription
    --yes, -ybooleanfalse—Skip confirmation prompt

    View command implementation.

    List documents in an organization.

    prb document list

    Accepts no positional arguments.

    FlagTypeDefaultRequiredDescription
    --afterstring""—Cursor from the previous page (the Next cursor line)
    --classificationstring""—Filter by classification (PUBLIC, INTERNAL, CONFIDENTIAL, SECRET)
    --document-typestring""—Filter by document type (OTHER, GOVERNANCE, POLICY, PROCEDURE, PLAN, REGISTER, RECORD, REPORT, TEMPLATE, STATEMENT_OF_APPLICABILITY)
    --jsonbooleanfalse—Output JSON (same as —output json)
    --limit, -Linteger30—Maximum number of documents to list
    --order-bystring""—Order by field (TITLE, CREATED_AT, UPDATED_AT, DOCUMENT_TYPE)
    --order-directionstring"DESC"—Sort direction (ASC, DESC)
    --orgstring""—Organization ID
    --output, -ostring""—Output format: json, table (default)
    --publishedbooleanfalse—Filter by whether a document has a published version
    --query, -qstring""—Search query
    --statusstring""—Filter by status (ACTIVE, ARCHIVED)
    --write-modestring""—Filter by write mode (AUTHORED, GENERATED)

    View command implementation.

    List approval decisions for a quorum.

    prb document list-approval-decisions <quorum-id>

    Requires 1 positional argument.

    FlagTypeDefaultRequiredDescription
    --afterstring""—Cursor from the previous page (the Next cursor line)
    --jsonbooleanfalse—Output JSON (same as —output json)
    --limit, -Linteger30—Maximum number of approval decisions to list
    --order-bystring""—Order by field (CREATED_AT)
    --order-directionstring"DESC"—Sort direction (ASC, DESC)
    --output, -ostring""—Output format: json, table (default)
    Terminal window
    # List approval decisions for a quorum
    prb document list-approval-decisions <quorum-id>

    View command implementation.

    List approval quorums for a document version.

    prb document list-approval-quorums <document-version-id>

    Requires 1 positional argument.

    FlagTypeDefaultRequiredDescription
    --afterstring""—Cursor from the previous page (the Next cursor line)
    --jsonbooleanfalse—Output JSON (same as —output json)
    --limit, -Linteger30—Maximum number of approval quorums to list
    --order-bystring""—Order by field (CREATED_AT)
    --order-directionstring"DESC"—Sort direction (ASC, DESC)
    --output, -ostring""—Output format: json, table (default)
    Terminal window
    # List approval quorums for a document version
    prb document list-approval-quorums <document-version-id>

    View command implementation.

    List revisions for a document.

    prb document list-history <document-id>

    Requires 1 positional argument.

    FlagTypeDefaultRequiredDescription
    --afterstring""—Cursor from the previous page (the Next cursor line)
    --jsonbooleanfalse—Output JSON (same as —output json)
    --limit, -Linteger30—Maximum number of sessions to list
    --order-bystring""—Order by field (ENDED_AT)
    --order-directionstring"DESC"—Sort direction (ASC, DESC)
    --output, -ostring""—Output format: json, table (default)
    Terminal window
    # List revisions
    prb document list-history <document-id>

    View command implementation.

    List versions of a document.

    prb document list-versions <document-id>

    Requires 1 positional argument.

    FlagTypeDefaultRequiredDescription
    --afterstring""—Cursor from the previous page (the Next cursor line)
    --jsonbooleanfalse—Output JSON (same as —output json)
    --limit, -Linteger30—Maximum number of versions to list
    --order-bystring""—Order by field (CREATED_AT)
    --order-directionstring"DESC"—Sort direction (ASC, DESC)
    --output, -ostring""—Output format: json, table (default)
    --statusstring""—Filter by status (PENDING_APPROVAL, PUBLISHED, REJECTED, VOIDED)
    Terminal window
    # List all versions of a document
    prb document list-versions <document-id>
    # List only published versions
    prb document list-versions <document-id> --status PUBLISHED

    View command implementation.

    Publish a document.

    prb document publish <document-id>

    Requires 1 positional argument.

    Publish the latest draft of a document.
    By default, the draft is published as a new major version. Pass --minor to
    publish as a minor version.
    When --approver is set (one or more profile IDs), an approval is requested
    instead of publishing immediately. Approvers are ignored with --minor.
    FlagTypeDefaultRequiredDescription
    --approverstring array[]—Approver profile ID (can be repeated; ignored with —minor)
    --changelogstring""—Changelog for this version (required)
    --minorbooleanfalse—Publish as a minor version (no approval flow)

    View command implementation.

    Restore a draft document to a collaboration history point.

    prb document restore-history <document-id>

    Requires 1 positional argument.

    FlagTypeDefaultRequiredDescription
    --headsstring""RequiredAutomerge heads to restore (comma-separated lowercase hex)
    --jsonbooleanfalse—Output JSON (same as —output json)
    --output, -ostring""—Output format: json, table (default)
    Terminal window
    # Restore to a session's heads
    prb document restore-history <document-id> --heads <hex>[,<hex>...]

    View command implementation.

    Unarchive a document.

    prb document unarchive <id>

    Requires 1 positional argument.

    View command implementation.

    Update a document.

    prb document update <id>

    Requires 1 positional argument.

    FlagTypeDefaultRequiredDescription
    --classificationstring""—Classification: PUBLIC, INTERNAL, CONFIDENTIAL, SECRET
    --contentstring""—Document content as markdown or ProseMirror JSON. Images and links to /api/files/v1/{id} are kept
    --document-typestring""—Document type: OTHER, GOVERNANCE, POLICY, PROCEDURE, PLAN, REGISTER, RECORD, REPORT, TEMPLATE, STATEMENT_OF_APPLICABILITY
    --titlestring""—Document title

    View command implementation.

    View a document.

    prb document view <id>

    Requires 1 positional argument.

    FlagTypeDefaultRequiredDescription
    --jsonbooleanfalse—Output JSON (same as —output json)
    --output, -ostring""—Output format: json, table (default)

    View command implementation.

    View an approval decision.

    prb document view-approval-decision <id>

    Requires 1 positional argument.

    FlagTypeDefaultRequiredDescription
    --jsonbooleanfalse—Output JSON (same as —output json)
    --output, -ostring""—Output format: json, table (default)

    View command implementation.

    View an approval quorum.

    prb document view-approval-quorum <id>

    Requires 1 positional argument.

    FlagTypeDefaultRequiredDescription
    --jsonbooleanfalse—Output JSON (same as —output json)
    --output, -ostring""—Output format: json, table (default)

    View command implementation.

    View the content and edit highlights of a revision.

    prb document view-history-snapshot <document-id> <revision-id>

    Requires 2 positional arguments.

    FlagTypeDefaultRequiredDescription
    --jsonbooleanfalse—Output JSON (same as —output json)
    --output, -ostring""—Output format: json, table (default)
    Terminal window
    # View the snapshot of one revision
    prb document view-history-snapshot <document-id> <revision-id>

    View command implementation.

    View a document version.

    prb document view-version <id>

    Requires 1 positional argument.

    FlagTypeDefaultRequiredDescription
    --jsonbooleanfalse—Output JSON (same as —output json)
    --output, -ostring""—Output format: json, table (default)

    View command implementation.