Comments
Comments
Section titled “Comments”Manage Confluence page comments - footer comments, inline comments, replies, and resolution.
Prerequisites
Section titled “Prerequisites”- Authenticated profile (
atlcli auth login) - Space permission: View to list comments, Edit to add/modify comments
Overview
Section titled “Overview”Confluence supports two types of comments:
- Footer comments - Appear at the bottom of the page
- Inline comments - Attached to specific text selections
atlcli fully supports both types with CRUD operations.
Footer Comments
Section titled “Footer Comments”List Comments
Section titled “List Comments”atlcli wiki page comments list --id 12345Options:
| Flag | Description |
|---|---|
--id |
Page ID or page URL (required) |
--comment |
Show only the thread of this comment |
--json |
JSON output |
Open a Comment Link
Section titled “Open a Comment Link”A link to a comment (?focusedCommentId=…, as Confluence puts it in notifications and “Copy link”) shows that comment’s thread, the comment itself marked with ▶. Footer comments, inline comments and replies all work:
atlcli wiki page comments --id "https://acme.atlassian.net/wiki/spaces/DOCS/pages/10001/Design+Review?focusedCommentId=20002"Comment 20002 on "Design Review"────────────────────────────────────────────────────────────• Ann Lee (11/12/2026) Should we split this section? ▶ Bob Ray (11/12/2026) Yes, see the API page.With the page id, --comment does the same: atlcli wiki page comments --id 10001 --comment 20002. For an inline comment the thread starts with the text it is about (On: "important phrase").
With --json, the full comment list is returned with a focusedComment object added (found, kind, thread).
If the comment no longer exists (deleted, or not visible to you), the command says so and lists the page’s other comments instead of failing.
Add Comment
Section titled “Add Comment”# Using positional argumentatlcli wiki page comments add --id 12345 "Great documentation!"
# From a fileatlcli wiki page comments add --id 12345 --file ./comment.txtOptions:
| Flag | Description |
|---|---|
--id |
Page ID (required) |
--file |
Read comment text from file |
Reply to Comment
Section titled “Reply to Comment”atlcli wiki page comments reply --id 12345 --parent 67890 "Thanks for the feedback!"Options:
| Flag | Description |
|---|---|
--id |
Page ID |
--parent |
Parent comment ID to reply to |
--file |
Read reply text from file |
Inline Comments
Section titled “Inline Comments”Inline comments are attached to specific text in the page content.
List Inline Comments
Section titled “List Inline Comments”atlcli wiki page comments list --id 12345 --inlineAdd Inline Comment
Section titled “Add Inline Comment”# Match text in page and attach commentatlcli wiki page comments add-inline --id 12345 --selection "text to match" "Consider rewording this"
# If text appears multiple times, use --match-indexatlcli wiki page comments add-inline --id 12345 --selection "common phrase" --match-index 2 "Comment on third occurrence"Options:
| Flag | Description |
|---|---|
--id |
Page ID |
--selection |
Text string to match in page content |
--match-index |
Which occurrence to match (0-indexed, default: 0) |
--file |
Read comment text from file |
Comment Resolution
Section titled “Comment Resolution”Mark inline comments as resolved (for review workflows). Only inline comments have a resolved state in Confluence; footer comments cannot be resolved.
# Resolve an inline commentatlcli wiki page comments resolve --comment 67890
# Reopen a resolved inline commentatlcli wiki page comments reopen --comment 67890atlcli reads the comment back after the update and fails if Confluence still reports the old state, so a reported success means the comment really changed.
Options:
| Flag | Description |
|---|---|
--comment |
Comment ID |
--type |
inline (default). footer is rejected: footer comments have no resolved state |
Delete Comment
Section titled “Delete Comment”# Delete footer commentatlcli wiki page comments delete --comment 67890 --confirm
# Delete inline commentatlcli wiki page comments delete --comment 67890 --type inline --confirmOptions:
| Flag | Description |
|---|---|
--comment |
Comment ID |
--type |
Comment type: footer (default), inline |
--confirm |
Skip confirmation prompt |
Sync Behavior
Section titled “Sync Behavior”During docs pull and docs push:
- Comments are not synced by default (they’re metadata, not content)
- Use
--include-commentsto export comments alongside pages - atlcli preserves comment IDs in a
.comments.jsonsidecar file when exported
Export with Comments
Section titled “Export with Comments”atlcli wiki docs pull ./docs --include-commentsCreates files like:
docs/├── my-page.md└── my-page.comments.jsonComments File Format
Section titled “Comments File Format”{ "pageId": "12345", "comments": [ { "id": "67890", "type": "footer", "body": "Great documentation!", "author": "alice@company.com", "created": "2025-01-14T10:00:00Z", "resolved": false, "replies": [] } ]}JSON Output
Section titled “JSON Output”All comment commands support --json for scripting:
atlcli wiki page comments list --id 12345 --json{ "schemaVersion": "1", "comments": [ { "id": "67890", "type": "footer", "body": "Great documentation!", "author": { "displayName": "Alice", "email": "alice@company.com" }, "created": "2025-01-14T10:00:00Z", "resolved": false, "replies": [] } ], "total": 1}Use Cases
Section titled “Use Cases”Code Review Workflow
Section titled “Code Review Workflow”# List unresolved commentsatlcli wiki page comments list --id 12345 --json | jq '.comments[] | select(.resolved == false)'
# Resolve after addressingatlcli wiki page comments resolve --comment 67890Bulk Comment Export
Section titled “Bulk Comment Export”# Export all comments from a spacefor page in $(atlcli wiki page list --space TEAM --json | jq -r '.pages[].id'); do atlcli wiki page comments list --id $page --json > "comments-$page.json"doneFind Pages with Unresolved Comments
Section titled “Find Pages with Unresolved Comments”# Check each page for unresolved commentsfor page in $(atlcli wiki page list --space TEAM --json | jq -r '.pages[].id'); do COUNT=$(atlcli wiki page comments list --id $page --json | jq '[.comments[] | select(.resolved == false)] | length') if [ "$COUNT" -gt 0 ]; then echo "Page $page has $COUNT unresolved comments" fidone