📖 中文 · Home · Authentication
Options can be placed before or after the URL (both ctxd -q <url> and ctxd <url> -q work).
| Option | Description |
|---|---|
-o, --output <path> |
Write to file/directory (default: stdout) |
-O, --auto-output |
Auto-generate output path by source (mutually exclusive with -o) |
-f, --format text|md |
Output format (default: md) |
-q, --quiet |
Suppress progress logs only — warnings and the completeness summary always print (auto-enabled when stderr is not a TTY) |
-v, --verbose |
Verbose logging |
--profile |
Print stage / HTTP timing summary |
--max-concurrency <N> |
Cap parallel work across fetchers (default: 5) |
--recurse-depth <N> |
Cross-source recursion: expand supported URLs found in output (default: 0=off, max 2; opt-in with 1/2) |
--no-recurse |
Disable cross-source recursion (equivalent to --recurse-depth 0; kept for explicitness) |
--max-chars <N> |
Cap output characters (default: 100000 for stdout; file output unlimited unless set explicitly; -1 = unlimited) |
--max-file-size <N> |
Cap per-attachment download size in bytes (default: 52428800 = 50 MiB; -1 = unlimited) |
--max-run-size <N> |
Cap total attachment download size per run in bytes (default: 524288000 = 500 MiB; -1 = unlimited) |
Export PR metadata, reviews, inline comments, timeline comments, and code changes. (Credentials: GITHUB_TOKEN)
ctxd https://github.com/owner/repo/pull/123
ctxd https://github.com/owner/repo/pull/123 -d full -o pr-123.md
ctxd -O https://github.com/owner/repo/pull/123| Option | Description |
|---|---|
-d, --diff-mode full|compact|stat |
Diff output mode (default: compact). compact lists files and hunk ranges and stat lists files and line counts — neither includes code, and the output says so; use full to review the changes |
--clean-body / --no-clean-body |
Strip bot-injected HTML noise from PR body (default: on) |
--no-bots |
Drop bot-authored reviews and comments (default: keep all bots) |
Export a full Slack thread with username resolution and attachments. (Credentials: SLACK_TOKEN)
# Client URL format
ctxd https://app.slack.com/client/T.../C.../thread/C...-1234567890.123456
# Archive URL format
ctxd 'https://your-workspace.slack.com/archives/C.../p...?thread_ts=...'When you copy a link to a specific reply (archive URL with ?thread_ts= where the path ts differs from the thread root), ctxd fetches the entire thread and highlights the focused message — a **Focused Message:** line in the header and a ▶ marker on that message in the conversation flow.
| Option | Description |
|---|---|
--download-files |
Download attachments next to the output as attachments/IMG_{file_id}.{ext} (e.g. IMG_F0AAAAAAA1.png); requires -o/-O and the files:read scope on the Slack token |
--raw |
Keep original Slack mrkdwn markup |
--since <ts> |
Export only the replies posted after message <ts> (e.g. 1735881234.123456) |
Every export records **Last Message ts:** in its header and run summary. When a thread gets new replies, pass that cursor back instead of re-reading the whole thread:
ctxd '<thread-url>' --since 1735881234.123456- Prints a short header (thread URL,
since, new message count, updatedLast Message ts) and the new replies only; if nothing is new, printsNo new replies since <ts>.and exits0. - With
-O, writesslack-<channel>-<thread>.since-<ts>.mdso it never overwrites the full export. - Edits or deletions on messages before
<ts>are not visible in this mode — run a full export when those matter.
Each attachment line keeps its Slack permalink and, when downloaded, appends — saved: attachments/IMG_<id>.<ext>. The run summary reports how many files were downloaded or skipped.
Export Confluence pages to Markdown. Defaults to a single page on stdout; pass -r / -i / --all-attachments with -o or -O for local files and page trees. (Credentials: Atlassian API token)
# Single page to stdout
ctxd https://your-site.atlassian.net/wiki/spaces/SPACE/pages/123456
# Tiny link (short URL) — resolved via authenticated redirect
ctxd https://your-site.atlassian.net/wiki/x/ABC123
# Recursive page tree with images -> directory
ctxd https://your-site.atlassian.net/wiki/spaces/SPACE/pages/123456 -r -i -o ./output
ctxd https://your-site.atlassian.net/wiki/spaces/SPACE/pages/123456 -r -i -O
# Single page to one file; downloads go to sibling page_attachments/
ctxd https://your-site.atlassian.net/wiki/spaces/SPACE/pages/123456 --all-attachments -o page.md| Option | Description |
|---|---|
-r, --recursive / --no-recursive |
Include every descendant page, at any depth (default: off). The run summary states the tree size: page tree: N descendant page(s), max depth D |
-i, --include-images / --no-include-images |
Download referenced images (default: off) |
--all-attachments |
Download every attachment — images to images/, other files (PDF, spreadsheets, …) to attachments/ (default: off) |
--debug |
Save raw HTML for debugging |
- Single file (
-o page.mdwithout-r): any path with a file suffix writes one Markdown file, with downloads placed in a siblingpage_attachments/(same layout as Jira). Passing-rwith a file-like-ois rejected. - Directory (
-o <dir>,-O, or any-rrun): writes<dir>/<id>_<title>/README.mdper page withimages/andattachments/beside it. For/wiki/x/<token>tiny links,-Onames the directoryconfluence-<token>. - Undownloaded attachments are never hidden: images not downloaded link to the stable REST download URL (usable with
curl -u "$CONFLUENCE_EMAIL:$CONFLUENCE_API_TOKEN" -L <url>, no expiring token), and every page ends with anAttachmentssection listing filename, MIME type, and size.
Export full Jira issue content (description, comments, custom fields, attachments). (Credentials: Atlassian API token)
ctxd https://your-site.atlassian.net/browse/PROJECT-123
ctxd https://your-site.atlassian.net/browse/PROJECT-123 -o issue.md
ctxd https://your-site.atlassian.net/browse/PROJECT-123 -i -O
ctxd https://your-site.atlassian.net/browse/PROJECT-123 --all-attachments -O| Option | Description |
|---|---|
-i, --include-images / --no-include-images |
Download images referenced from the issue body (default: off) |
--all-attachments |
Download every attachment on the issue (default: off) |
--debug |
Save raw HTML for debugging |
- Custom fields: rich-text custom fields render as Markdown; serializable plain fields (strings, numbers, booleans, simple lists/dicts) are included too. Unsupported nested objects are omitted with a stderr warning and a summary note — never dropped silently.
- Attachments:
-iand--all-attachmentsrequire-o <file>or-O. Downloaded files land in<output-stem>_attachments/<attachment-id>-<filename>, and links in the description, comments, and custom fields are rewritten to local relative paths. Even when nothing is downloaded, every export ends with anAttachmentsinventory.
A request raised through a Jira Service Management portal is readable even when you are only its customer. The platform API answers a customer with 404 (no Browse permission), indistinguishable from a missing issue, so ctxd decides by project: on a 404 it retries through the service desk customer API only when the URL is a portal link (/servicedesk/customer/portal/<id>/<KEY>) or the project is one of the service desks visible to you. That list is fetched once and cached for a day in ~/.cache/ctxd/ ($XDG_CACHE_HOME respected), so a genuine 404 in an ordinary project costs no extra request. Agents of the service desk still get the full platform-API export, internal comments included.
The customer view has less than the agent view, and the output says so: assignee, priority, labels, components and the update time show (not visible in portal), comments are the public ones only, and the run summary notes that the request was read through the customer API. Request form fields other than summary and description are exported under their portal labels.
By default, cross-source recursion is off (--recurse-depth 0). Opt in with --recurse-depth 1 or 2 to have ctxd scan the rendered output for supported URLs (Slack, GitHub PR, Confluence, Jira) and fetch them too, appending the results as a labelled appendix.
# Enable recursion (depth=1, auto-expands linked supported URLs)
ctxd '<url>' --recurse-depth 1
# Deeper recursion (max 2)
ctxd '<url>' --recurse-depth 2Key behaviours:
- Deduplication: the same URL is never fetched twice within one run.
- Cap: at most 5 child URLs are expanded per level (prevents Jira issue-link explosions).
- Graceful skip: if a child URL lacks credentials, the appendix notes the skip instead of failing the run.
- Confluence directory export: recursion is disabled when using
-o/-Owith Confluence directory exports; use stdout for recursion.
Every run prints a one-line completeness summary to stderr (always visible, including under -q):
ctxd summary: source=jira | fetched=1 | rendered=1 | artifacts=1
Non-zero skipped, failed, or truncated counts and free-form notes (omitted custom fields, failed downloads) appear alongside it. When writing to disk, a machine-readable manifest with the same fields is written next to the output:
| Output mode | Manifest path |
|---|---|
Single file (-o issue.md / -O) |
issue.md.manifest.json |
| Directory (Confluence tree) | <dir>/manifest.json |
- Atomic writes: text and binary files are written via temp file + rename to avoid half-written artifacts on interrupt.
--max-chars: truncates at a newline boundary, closes open code fences, and appends a truncation notice. Applies to stdout by default (100000); pass explicitly to cap file output as well.- Attachment size caps: streamed downloads enforce per-file (
--max-file-size, 50 MiB) and per-run (--max-run-size, 500 MiB) budgets shared across the recursion tree. Exceeded downloads warn and count asfailed.