Skip to main content
The cops confluence page commands let you inspect Confluence pages and validate their readiness for release documentation. They call the Confluence REST API v2 (/rest/api/content).

cops confluence page get

Fetch details for a single Confluence page by its numeric page ID.Alias: cops confluence page details

​
Usage

cops confluence page get <pageId> [flags]

​
Arguments

ArgumentRequiredDescription
pageIdYesNumeric Confluence page ID

​
Flags

​
--output
string
default:"table"
Output format: table, json, or markdown.
​
--insecure
boolean
default:"false"
Disable TLS certificate validation. Use only with self-signed certificates in trusted networks.
​
--profile
string
Override the active config profile.

​
Output columns

id, title, type, spaceKey, spaceName, version, updatedAt

​
Examples

cops confluence page get 123456789

id           title              type  spaceKey  spaceName         version  updatedAt
───────────  ─────────────────  ────  ────────  ────────────────  ───────  ────────────────────
123456789    Release Notes v2   page  OPS       Operations Space  4        2026-03-15T10:22:00Z
Fetch content metadata for a page by its numeric page ID. Returns body size and ancestor count in addition to standard page fields.

​
Usage

cops confluence page content <pageId> [flags]

​
Arguments

ArgumentRequiredDescription
pageIdYesNumeric Confluence page ID

​
Flags

​
--output
string
default:"table"
Output format: table, json, or markdown.
​
--insecure
boolean
default:"false"
Disable TLS certificate validation. Use only with self-signed certificates in trusted networks.
​
--profile
string
Override the active config profile.

​
Output columns

id, title, spaceKey, version, updatedAt, bodyLength, ancestorCount

​
Examples

cops confluence page content 123456789

id           title              spaceKey  version  updatedAt             bodyLength  ancestorCount
───────────  ─────────────────  ────────  ───────  ────────────────────  ──────────  ─────────────
123456789    Release Notes v2   OPS       4        2026-03-15T10:22:00Z  8420        2
Find a Confluence page by its space key and exact title.Alias: cops confluence page title

​
Usage

cops confluence page by-title --space <spaceKey> --title <title> [flags]

​
Flags

​
--space
string
required
Confluence space key (e.g. OPS, ENG).
​
--title
string
required
Exact page title to search for.
​
--output
string
default:"table"
Output format: table, json, or markdown.
​
--insecure
boolean
default:"false"
Disable TLS certificate validation. Use only with self-signed certificates in trusted networks.
​
--profile
string
Override the active config profile.

​
Output columns

id, title, type, spaceKey, spaceName, version, updatedAtIf no page matches, the output is empty and the found metadata field is false.

​
Examples

cops confluence page by-title --space OPS --title "Release Notes v2"

id           title              type  spaceKey  spaceName         version  updatedAt
───────────  ─────────────────  ────  ────────  ────────────────  ───────  ────────────────────
123456789    Release Notes v2   page  OPS       Operations Space  4        2026-03-15T10:22:00Z
Search Confluence pages using a CQL (Confluence Query Language) query.Alias: cops confluence page find

​
Usage

cops confluence page search --cql <query> [flags]

​
Flags

​
--cql
string
required
CQL query string. See the Confluence CQL documentation for syntax.
​
--limit
number
default:"20"
Maximum number of pages to return.
​
--output
string
default:"table"
Output format: table, json, or markdown.
​
--insecure
boolean
default:"false"
Disable TLS certificate validation. Use only with self-signed certificates in trusted networks.
​
--profile
string
Override the active config profile.

​
Output columns

id, title, type, spaceKey, version, updatedAt

​
Examples

cops confluence page search --cql "space = OPS AND label = release-notes"

id           title               type  spaceKey  version  updatedAt
───────────  ──────────────────  ────  ────────  ───────  ────────────────────
123456789    Release Notes v2    page  OPS       4        2026-03-15T10:22:00Z
987654321    Deployment Runbook  page  OPS       2        2026-03-10T08:05:00Z
Check whether a Confluence page was updated within a maximum number of days. Exits with code 1 if the page is stale.

​
Usage

cops confluence page freshness <pageId> [flags]

​
Arguments

ArgumentRequiredDescription
pageIdYesNumeric Confluence page ID

​
Flags

​
--maxAgeDays
number
default:"7"
Maximum allowed page age in days. The command exits with code 1 if the page is older than this threshold.
​
--output
string
default:"table"
Output format: table, json, or markdown.
​
--insecure
boolean
default:"false"
Disable TLS certificate validation. Use only with self-signed certificates in trusted networks.
​
--profile
string
Override the active config profile.

​
Output columns

id, title, updatedAt, ageDays, maxAgeDays, fresh

​
Exit codes

CodeMeaning
0Page is within the age threshold
1Page is older than --maxAgeDays

​
Examples

cops confluence page freshness 123456789

id           title              updatedAt             ageDays  maxAgeDays  fresh
───────────  ─────────────────  ────────────────────  ───────  ──────────  ─────
123456789    Release Notes v2   2026-03-15T10:22:00Z  4        7           true
Use cops confluence page freshness in CI pipelines to gate a release on recently updated documentation.
Run a suite of release-doc health checks against a Confluence page: verifies the page exists, confirms required section headings are present, and checks that the page is not stale. Exits with code 1 if any check produces a warn or fail result.

​
Usage

cops confluence page checks --space <spaceKey> --title <title> [flags]

​
Flags

​
--space
string
required
Confluence space key (e.g. OPS).
​
--title
string
required
Exact title of the Confluence page to check.
​
--requiredSections
string
default:""
Comma-separated list of text fragments or section headings that must appear in the page body (case-insensitive). For example: "Overview,Rollback Steps,Sign-off".
​
--maxAgeDays
number
default:"14"
Maximum allowed page age in days. Pages older than this threshold produce a warn result.
​
--output
string
default:"table"
Output format: table, json, or markdown.
​
--insecure
boolean
default:"false"
Disable TLS certificate validation. Use only with self-signed certificates in trusted networks.
​
--profile
string
Override the active config profile.

​
Output columns

check, status, detailsEach row represents one check. The status value is pass, warn, or fail.
CheckDescription
page_existsVerifies the page was found in the given space
required_sectionsVerifies all --requiredSections fragments appear in the page body
page_freshnessVerifies the page was updated within --maxAgeDays

​
Exit codes

CodeMeaning
0All checks passed
1One or more checks produced warn or fail

​
Examples

cops confluence page checks --space OPS --title "Release Notes v2" --requiredSections "Overview,Rollback Steps" --maxAgeDays 7

check              status  details
─────────────────  ──────  ───────────────────────────────────────
page_exists        pass    Found page 123456789
required_sections  pass    All required sections present
page_freshness     warn    Page age 18 days exceeds 14
If the page is not found, only the page_exists check row is emitted and the command exits immediately with code 1.

cops confluence

Overview of all Confluence commands and common flags.

Release gates

Use page checks as gates in a release workflow.

Build docs developers (and LLMs) love

Get started for freeTalk to us