twitter-cli-cookiefile/SCHEMA.md

Structured Output Schema

twitter-cli uses a shared agent-friendly envelope for machine-readable output.

Success

ok: true
schema_version: "1"
data: ...
pagination:
  nextCursor: "optional-cursor"

Error

ok: false
schema_version: "1"
error:
  code: api_error
  message: User @foo not found

Notes

• --yaml and --json both use this envelope
• non-TTY stdout defaults to YAML
• tweet and user lists are returned under data
• timeline-style list commands may also return pagination.nextCursor
• article returns a single tweet object under data
• status returns data.authenticated plus data.user
• whoami returns data.user
• write commands also support explicit --json / --yaml

Article Fields

twitter article <id> --json returns the standard tweet object plus:

data:
  id: "1234567890"
  articleTitle: "Article Title"
  articleText: |
    # Heading
    Body text...

Error Codes

Common structured error codes:

• not_authenticated
• not_found
• invalid_input
• rate_limited
• api_error