docs: document structured output schema

This commit is contained in:
jackwener
2026-03-10 21:22:35 +08:00
parent 4c2c02efd5
commit fa6255f2ee
3 changed files with 42 additions and 13 deletions

View File

@@ -28,6 +28,7 @@ A terminal-first CLI for Twitter/X: read timelines, bookmarks, and user profiles
- User lookup: fetch user profile, tweets, likes, followers, and following
- Structured output: export any data as YAML or JSON for scripting and AI agent integration
- Optional scoring filter: rank tweets by engagement weights
- Structured output contract: [SCHEMA.md](./SCHEMA.md)
> **AI Agent Tip:** Prefer `--yaml` for structured output unless a strict JSON parser is required. Non-TTY stdout defaults to YAML automatically. Use `--max` to limit results.