X to Markdown
Converts X content to markdown:
- - Tweets/threads → Markdown with YAML front matter
- X Articles → Full content extraction
Script Directory
Scripts located in scripts/ subdirectory.
Path Resolution:
- 1.
{baseDir} = this SKILL.md's directory - Script path = INLINECODE2
- Resolve
${BUN_X} runtime: if bun installed → bun; if npx available → npx -y bun; else suggest installing bun
Consent Requirement
Before any conversion, check and obtain consent.
Consent Flow
Step 1: Check consent file
CODEBLOCK0
Step 2: If accepted: true and disclaimerVersion: "1.0" → print warning and proceed:
CODEBLOCK1
Step 3: If missing or version mismatch → display disclaimer:
CODEBLOCK2
Use AskUserQuestion with options: "Yes, I accept" | "No, I decline"
Step 4: On accept → create consent file:
CODEBLOCK3
Step 5: On decline → output "User declined. Exiting." and stop.
Preferences (EXTEND.md)
Check EXTEND.md existence (priority order):
CODEBLOCK4
CODEBLOCK5
┌────────────────────────────────────────────────────────────┬───────────────────┐
│ Path │ Location │
├────────────────────────────────────────────────────────────┼───────────────────┤
│ .baoyu-skills/baoyu-danger-x-to-markdown/EXTEND.md │ Project directory │
├────────────────────────────────────────────────────────────┼───────────────────┤
│ $HOME/.baoyu-skills/baoyu-danger-x-to-markdown/EXTEND.md │ User home │
└────────────────────────────────────────────────────────────┴───────────────────┘
┌───────────┬───────────────────────────────────────────────────────────────────────────┐
│ Result │ Action │
├───────────┼───────────────────────────────────────────────────────────────────────────┤
│ Found │ Read, parse, apply settings │
├───────────┼───────────────────────────────────────────────────────────────────────────┤
│ Not found │ MUST run first-time setup (see below) — do NOT silently create defaults │
└───────────┴───────────────────────────────────────────────────────────────────────────┘
EXTEND.md Supports: Download media by default | Default output directory
First-Time Setup (BLOCKING)
CRITICAL: When EXTEND.md is not found, you MUST use AskUserQuestion to ask the user for their preferences before creating EXTEND.md. NEVER create EXTEND.md with defaults without asking. This is a BLOCKING operation — do NOT proceed with any conversion until setup is complete.
Use AskUserQuestion with ALL questions in ONE call:
Question 1 — header: "Media", question: "How to handle images and videos in tweets?"
- - "Ask each time (Recommended)" — After saving markdown, ask whether to download media
- "Always download" — Always download media to local imgs/ and videos/ directories
- "Never download" — Keep original remote URLs in markdown
Question 2 — header: "Output", question: "Default output directory?"
- - "x-to-markdown (Recommended)" — Save to ./x-to-markdown/{username}/{tweet-id}.md
- (User may choose "Other" to type a custom path)
Question 3 — header: "Save", question: "Where to save preferences?"
- - "User (Recommended)" — ~/.baoyu-skills/ (all projects)
- "Project" — .baoyu-skills/ (this project only)
After user answers, create EXTEND.md at the chosen location, confirm "Preferences saved to [path]", then continue.
Full reference: references/config/first-time-setup.md
Supported Keys
| Key | Default | Values | Description |
|---|
| INLINECODE13 | INLINECODE14 | INLINECODE15 / 1 / INLINECODE17 | INLINECODE18 = prompt each time, 1 = always download, 0 = never |
| INLINECODE21 |
empty | path or empty | Default output directory (empty =
./x-to-markdown/) |
Value priority:
- 1. CLI arguments (
--download-media, -o) - EXTEND.md
- Skill defaults
Usage
CODEBLOCK6
Options
| Option | Description |
|---|
| INLINECODE25 | Tweet or article URL |
| INLINECODE26 |
Output path |
|
--json | JSON output |
|
--download-media | Download image/video assets to local
imgs/ and
videos/, and rewrite markdown links to local relative paths |
|
--login | Refresh cookies only |
Supported URLs
- - INLINECODE32
- INLINECODE33
- INLINECODE34
Output
CODEBLOCK7
File structure: INLINECODE35
When --download-media is enabled:
- - Images are saved to
imgs/ next to the markdown file - Videos are saved to
videos/ next to the markdown file - Markdown media links are rewritten to local relative paths
Media Download Workflow
Based on download_media setting in EXTEND.md:
| Setting | Behavior |
|---|
| INLINECODE40 (always) | Run script with --download-media flag |
| INLINECODE42 (never) |
Run script without
--download-media flag |
|
ask (default) | Follow the ask-each-time flow below |
Ask-Each-Time Flow
- 1. Run script without
--download-media → markdown saved - Check saved markdown for remote media URLs (
https:// in image/video links) - If no remote media found → done, no prompt needed
- If remote media found → use
AskUserQuestion:
- header: "Media", question: "Download N images/videos to local files?"
- "Yes" — Download to local directories
- "No" — Keep remote URLs
- 5. If user confirms → run script again with
--download-media (overwrites markdown with localized links)
Authentication
- 1. Environment variables (preferred):
X_AUTH_TOKEN, INLINECODE50 - Chrome login (fallback): Auto-opens Chrome, caches cookies locally
Extension Support
Custom configurations via EXTEND.md. See Preferences section for paths and supported options.
X 转 Markdown
将 X 内容转换为 Markdown:
- - 推文/线程 → 带 YAML 前置元数据的 Markdown
- X 文章 → 完整内容提取
脚本目录
脚本位于 scripts/ 子目录中。
路径解析:
- 1. {baseDir} = 此 SKILL.md 文件所在目录
- 脚本路径 = {baseDir}/scripts/main.ts
- 解析 ${BUN_X} 运行时:如果已安装 bun → bun;如果可用 npx → npx -y bun;否则建议安装 bun
同意要求
在任何转换之前,检查并获取同意。
同意流程
步骤 1:检查同意文件
bash
macOS
cat ~/Library/Application\ Support/baoyu-skills/x-to-markdown/consent.json
Linux
cat ~/.local/share/baoyu-skills/x-to-markdown/consent.json
步骤 2:如果 accepted: true 且 disclaimerVersion: 1.0 → 打印警告并继续:
警告:正在使用逆向工程的 X API。接受时间:
步骤 3:如果文件缺失或版本不匹配 → 显示免责声明:
免责声明
此工具使用逆向工程的 X API,非官方 API。
风险:
- - 如果 X 更改 API 可能失效
- 不提供任何保证或支持
- 可能导致账户限制
- 使用风险自负
接受条款并继续?
使用 AskUserQuestion 并提供选项:是,我接受 | 否,我拒绝
步骤 4:接受后 → 创建同意文件:
json
{
version: 1,
accepted: true,
acceptedAt: ,
disclaimerVersion: 1.0
}
步骤 5:拒绝后 → 输出用户已拒绝。退出。并停止。
偏好设置 (EXTEND.md)
检查 EXTEND.md 是否存在(优先级顺序):
bash
macOS, Linux, WSL, Git Bash
test -f .baoyu-skills/baoyu-danger-x-to-markdown/EXTEND.md && echo project
test -f ${XDG
CONFIGHOME:-$HOME/.config}/baoyu-skills/baoyu-danger-x-to-markdown/EXTEND.md && echo xdg
test -f $HOME/.baoyu-skills/baoyu-danger-x-to-markdown/EXTEND.md && echo user
powershell
PowerShell (Windows)
if (Test-Path .baoyu-skills/baoyu-danger-x-to-markdown/EXTEND.md) { project }
$xdg = if ($env:XDG
CONFIGHOME) { $env:XDG
CONFIGHOME } else { $HOME/.config }
if (Test-Path $xdg/baoyu-skills/baoyu-danger-x-to-markdown/EXTEND.md) { xdg }
if (Test-Path $HOME/.baoyu-skills/baoyu-danger-x-to-markdown/EXTEND.md) { user }
┌────────────────────────────────────────────────────────────┬───────────────────┐
│ 路径 │ 位置 │
├────────────────────────────────────────────────────────────┼───────────────────┤
│ .baoyu-skills/baoyu-danger-x-to-markdown/EXTEND.md │ 项目目录 │
├────────────────────────────────────────────────────────────┼───────────────────┤
│ $HOME/.baoyu-skills/baoyu-danger-x-to-markdown/EXTEND.md │ 用户主目录 │
└────────────────────────────────────────────────────────────┴───────────────────┘
┌───────────┬───────────────────────────────────────────────────────────────────────────┐
│ 结果 │ 操作 │
├───────────┼───────────────────────────────────────────────────────────────────────────┤
│ 找到 │ 读取、解析、应用设置 │
├───────────┼───────────────────────────────────────────────────────────────────────────┤
│ 未找到 │ 必须运行首次设置(见下文)—— 不要静默创建默认值 │
└───────────┴───────────────────────────────────────────────────────────────────────────┘
EXTEND.md 支持:默认下载媒体 | 默认输出目录
首次设置(阻塞操作)
关键:当未找到 EXTEND.md 时,你必须使用 AskUserQuestion 询问用户的偏好,然后创建 EXTEND.md。切勿在未询问的情况下使用默认值创建 EXTEND.md。这是一个阻塞操作——在设置完成之前,不要进行任何转换。
使用 AskUserQuestion 在一次调用中提出所有问题:
问题 1 — 标题:媒体,问题:如何处理推文中的图片和视频?
- - 每次都询问(推荐) — 保存 Markdown 后,询问是否下载媒体
- 始终下载 — 始终将媒体下载到本地 imgs/ 和 videos/ 目录
- 从不下载 — 在 Markdown 中保留原始远程 URL
问题 2 — 标题:输出,问题:默认输出目录?
- - x-to-markdown(推荐) — 保存到 ./x-to-markdown/{用户名}/{推文ID}.md
- (用户可选择其他以输入自定义路径)
问题 3 — 标题:保存,问题:偏好设置保存位置?
- - 用户(推荐) — ~/.baoyu-skills/(所有项目)
- 项目 — .baoyu-skills/(仅此项目)
用户回答后,在所选位置创建 EXTEND.md,确认偏好设置已保存至 [路径],然后继续。
完整参考:references/config/first-time-setup.md
支持的键
| 键 | 默认值 | 值 | 描述 |
|---|
| downloadmedia | ask | ask / 1 / 0 | ask = 每次提示,1 = 始终下载,0 = 从不 |
| defaultoutput_dir |
空 | 路径或空 | 默认输出目录(空 = ./x-to-markdown/) |
值优先级:
- 1. CLI 参数(--download-media、-o)
- EXTEND.md
- 技能默认值
使用方法
bash
${BUN_X} {baseDir}/scripts/main.ts
${BUN_X} {baseDir}/scripts/main.ts -o output.md
${BUN_X} {baseDir}/scripts/main.ts --download-media
${BUN_X} {baseDir}/scripts/main.ts --json
选项
| 选项 | 描述 |
|---|
| <url> | 推文或文章 URL |
| -o <路径> |
输出路径 |
| --json | JSON 输出 |
| --download-media | 将图片/视频资源下载到本地 imgs/ 和 videos/,并将 Markdown 链接重写为本地相对路径 |
| --login | 仅刷新 cookies |
支持的 URL
- - https://x.com/<用户>/status/
- https://twitter.com/<用户>/status/
- https://x.com/i/article/
输出
markdown
url: https://x.com/user/status/123
author: 名称 (@用户)
tweetCount: 3
coverImage: https://pbs.twimg.com/media/example.jpg
内容...
文件结构:x-to-markdown/{用户名}/{推文ID}/{内容别名}.md
当启用 --download-media 时:
- - 图片保存到 Markdown 文件旁边的 imgs/ 目录
- 视频保存到 Markdown 文件旁边的 videos/ 目录
- Markdown 媒体链接被重写为本地相对路径
媒体下载工作流
基于 EXTEND.md 中的 download_media 设置:
| 设置 | 行为 |
|---|
| 1(始终) | 使用 --download-media 标志运行脚本 |
| 0(从不) |
不使用 --download-media 标志运行脚本 |
| ask(默认) | 遵循下面的每次询问流程 |
每次询问流程
- 1. 不使用 --download-media 运行脚本 → 保存 Markdown
- 检查保存的 Markdown 中是否有远程媒体 URL(图片/视频链接中的 https://)
- 如果未找到远程媒体 → 完成,无需提示
- 如果找到远程媒体 → 使用 AskUserQuestion:
- 标题:媒体,问题:下载 N