docs: document quoted tweet depth

This commit is contained in:
Peter Steinberger
2026-01-01 10:45:25 +01:00
parent df6b92e39c
commit 529403e386
2 changed files with 9 additions and 3 deletions
+3
View File
@@ -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`).
+6 -3
View File
@@ -69,6 +69,7 @@ bird query-ids --fresh
Global options:
- `--timeout <ms>`: abort requests after the given timeout (milliseconds).
- `--quote-depth <n>`: 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)