Skip to content

Comments

List comments on a Merfolk diagram.

Usage

merfolk diagrams comments <id> [flags]

Arguments

Argument Description
id The diagram ID (required)

Flags

Flag Description
--json Output comments as JSON

Examples

# List comments on a diagram
merfolk diagrams comments abc123

# Get comments as JSON
merfolk diagrams comments abc123 --json

Output

Default output:

COMMENT                          AUTHOR        POSITION
"Check the auth flow here"       alice@ex.com  (45%, 30%)
"Missing error state"            bob@ex.com    (72%, 60%)

With --json:

[
  {
    "id": "cmt1",
    "body": "Check the auth flow here",
    "author": "alice@example.com",
    "positionX": 45.2,
    "positionY": 30.1,
    "createdAt": "2024-01-15T09:00:00Z"
  }
]

Comments have positionX and positionY as float percentages (0–100) of the diagram container’s dimensions.

Exit codes

Code Meaning
0 Success
2 Not authenticated
3 Diagram not found
Navigation

Type to search…

↑↓ navigate↵ selectEsc close