From 529403e38669a58ce86f63fcd718bf6da59086fe Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Thu, 1 Jan 2026 10:45:25 +0100 Subject: [PATCH] docs: document quoted tweet depth --- CHANGELOG.md | 3 +++ README.md | 9 ++++++--- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 661a665..05c54ca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,9 @@ ## 0.4.1 — Unreleased +### Added +- Quoted tweet data in JSON output + `--quote-depth` (thanks @alexknowshtml). + ### Changed - Cookie extraction now uses `@steipete/sweet-cookie` (drops `sqlite3` CLI + custom browser readers in `bird`). diff --git a/README.md b/README.md index 0158651..12879fd 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,7 @@ bird query-ids --fresh Global options: - `--timeout `: abort requests after the given timeout (milliseconds). +- `--quote-depth `: max quoted tweet depth in JSON output (default: 1; 0 disables). - `--plain`: stable output (no emoji, no color). - `--no-emoji`: disable emoji output. - `--no-color`: disable ANSI colors (or set `NO_COLOR=1`). @@ -108,12 +109,14 @@ Example `~/.config/bird/config.json5`: // Cookie source order for browser extraction (string or array) cookieSource: ["firefox", "safari"], firefoxProfile: "default-release", - timeoutMs: 20000 + timeoutMs: 20000, + quoteDepth: 1 } ``` Environment shortcuts: - `BIRD_TIMEOUT_MS` +- `BIRD_QUOTE_DEPTH` ## Output @@ -130,14 +133,14 @@ When using `--json`, tweet objects include: | `id` | string | Tweet ID | | `text` | string | Full tweet text (includes Note/Article content when present) | | `author` | object | `{ username, name }` | -| `authorId` | string | Author's user ID | +| `authorId` | string? | Author's user ID | | `createdAt` | string | Timestamp | | `replyCount` | number | Number of replies | | `retweetCount` | number | Number of retweets | | `likeCount` | number | Number of likes | | `conversationId` | string | Thread conversation ID | | `inReplyToStatusId` | string? | Parent tweet ID (present if this is a reply) | -| `quotedTweet` | object? | Embedded quote tweet with `{ id, text, author, authorId }` (present if this is a quote tweet) | +| `quotedTweet` | object? | Embedded quote tweet (same schema; depth controlled by `--quote-depth`) | ## Query IDs (GraphQL)