ctxd

Unified context dumper for LLM workflows.

📖 中文文档

Supported Sources

Source	URL Pattern
GitHub PR	https://github.com/<owner>/<repo>/pull/<number>
Slack Thread	https://*.slack.com/archives/... or .../client/.../thread/...
Confluence	https://*.atlassian.net/wiki/...
Jira	https://*.atlassian.net/browse/<KEY>

Installation

Homebrew (recommended)

brew tap cheerchen/tap
brew install ctxd

From source

cd ctxd
uv sync --group dev

Shell Alias

# zsh / bash
eval "$(ctxd init zsh)"

# fish
ctxd init fish | source

This enables the ctx shorthand for ctxd.

Global Options

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 (auto-enabled when stderr is not a TTY)
-v, --verbose	Verbose logging

Options can be placed before or after the URL (e.g. both ctxd -q <url> and ctxd <url> -q).

---

GitHub PR

Export PR metadata, reviews, inline comments, timeline comments, and code changes.

Prerequisites

Install and authenticate GitHub CLI:

brew install gh
gh auth login

Diff generation uses the GitHub API (gh pr diff and /pulls/{n}/files), so it works from any working directory — no local clone of the target repo required.

Usage

ctxd https://github.com/owner/repo/pull/123
ctxd https://github.com/owner/repo/pull/123 -o pr-123.md
ctxd -O https://github.com/owner/repo/pull/123

Output structure

The generated markdown has the following top-level sections:

• ## Reviews — each review with @author, **STATE** (APPROVED / CHANGES_REQUESTED / COMMENTED / DISMISSED), submission timestamp, and body. Empty-body reviews (e.g. bare approvals) are preserved.
• ## Inline Review Comments — inline code comments grouped by file, rendered as @user [SIDE] L{start}-{end} (timestamp): with LEFT/RIGHT diff side and multi-line ranges.
• ## Timeline Comments — issue-level comments on the PR conversation.
• ## Git Diff — code diff (mode controlled by -d).

All reviews and comments include ISO-8601 timestamps (with timezone) from the GitHub API. Bot-authored content is kept by default — pass --no-bots to drop reviews/comments from pr-agent, devin-ai-integration, coderabbitai, etc.

Options

Option	Description
-d, --diff-mode full|compact|stat	Diff output mode (default: compact)
--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)

---

Slack Thread

Export a full Slack thread with username resolution and attachments.

Prerequisites

Requires a Slack User Token (xoxp-...) with the following scopes:

• channels:history, groups:history, im:history, mpim:history
• users:read
• files:read (if downloading attachments)

Obtain at: api.slack.com/apps → Your App → OAuth & Permissions → User Token.

Configure the token (pick one):

# Option 1: Environment variable
export SLACK_TOKEN="xoxp-..."

# Option 2: Config file
mkdir -p ~/.config/ctxd
echo 'SLACK_TOKEN=xoxp-...' >> ~/.config/ctxd/config

Usage

# New 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=...

Options

Option	Description
--download-files	Download attachments to ./attachments
--raw	Keep original Slack mrkdwn markup

---

Confluence

Export Confluence pages to Markdown. By default prints a single page to stdout; pass -r / -i with -o <dir> (or -O) to opt into recursive export with images.

Prerequisites

Requires an Atlassian API Token. Obtain at: id.atlassian.com/manage-profile/security/api-tokens.

Configure (all three values are required). Pick one:

# Option 1: Environment variables
export CONFLUENCE_BASE_URL="https://your-site.atlassian.net"
export CONFLUENCE_EMAIL="you@example.com"
export CONFLUENCE_API_TOKEN="your-token"

# Option 2: Config file (recommended for persistent use)
mkdir -p ~/.config/ctxd
cat >> ~/.config/ctxd/config <<'EOF'
CONFLUENCE_BASE_URL=https://your-site.atlassian.net
CONFLUENCE_EMAIL=you@example.com
CONFLUENCE_API_TOKEN=your-token
EOF
chmod 600 ~/.config/ctxd/config

Environment variables take precedence over the config file, so CI and one-off overrides work unchanged. If the file is readable by group/others, ctxd prints a one-shot stderr warning with the exact chmod 600 command to fix it.

Usage

# Default: single page to stdout
ctxd https://your-site.atlassian.net/wiki/spaces/SPACE/pages/123456

# Recursive export with images, to an explicit directory
ctxd https://your-site.atlassian.net/wiki/spaces/SPACE/pages/123456 -r -i -o ./output

# Or let ctxd pick the output directory name
ctxd https://your-site.atlassian.net/wiki/spaces/SPACE/pages/123456 -r -i -O

Note: -r / -i / --all-attachments require -o <dir> or -O (Confluence writes a directory tree / images to disk).

Options

Option	Description
-r, --recursive / --no-recursive	Include child pages (default: off)
-i, --include-images / --no-include-images	Download referenced images (default: off)
--all-attachments	Download all attachments (default: only referenced images)
--debug	Save raw HTML for debugging

---

Jira

Export full Jira issue content (description, comments, custom fields).

Prerequisites

Shares authentication with Confluence — configure via environment variables or ~/.config/ctxd/config (see the Confluence section for the full config-file setup, including chmod 600):

export CONFLUENCE_BASE_URL="https://your-site.atlassian.net"
export CONFLUENCE_EMAIL="you@example.com"
export CONFLUENCE_API_TOKEN="your-token"

Usage

ctxd https://your-site.atlassian.net/browse/PROJECT-123
ctxd https://your-site.atlassian.net/browse/PROJECT-123 -o issue.md

Options

Option	Description
--debug	Save raw HTML (.debug.html) for troubleshooting conversion issues

License

MIT