mirror of
https://github.com/JimLiu/baoyu-skills.git
synced 2026-08-07 09:23:04 +08:00
2c800c670a
* docs: add runtime-neutral User Input Tools convention across skills Introduce docs/user-input-tools.md as the author-side canonical source and inline the tool-selection rule into every SKILL.md that prompts the user. Also add Skill Self-Containment and User Input Tools sections to CLAUDE.md and the copy-verbatim template to docs/creating-skills.md, so skills stay portable across Claude Code, Codex, Hermes, and other runtimes. * feat: runtime-neutral image generation convention across skills - Introduce inline `## Image Generation Tools` rule in every rendering SKILL.md so skills delegate backend choice instead of hard-coding one; author-side canonical copy lives in docs/image-generation-tools.md. - Add `## Reference Images` support (`--ref`, frontmatter `references:` with direct/style/palette usage) to all seven image-rendering skills. - Move build-batch.ts (with ref propagation into batch JSON) from baoyu-article-illustrator to baoyu-imagine so non-backend skills don't own backend-specific scripts; update baoyu-image-gen stub in sync and relax the CLAUDE.md deprecation note accordingly. * refactor: slim heavy SKILL.md files and move detail to references/ Trim the four largest active skills and move presets, option tables, and confirmation scripts into per-skill references/ so SKILL.md stays focused on the decision flow. - baoyu-slide-deck: 761→258, + styles-gallery.md, confirmation.md - baoyu-image-cards: 657→280, + gallery.md, confirmation.md - baoyu-post-to-wechat: 518→267, + multi-account.md, api-setup.md - baoyu-imagine: 500→230, + providers/, usage-examples.md Also un-deprecate baoyu-image-gen (drop stub warning) so it stays functional alongside baoyu-imagine, and update CLAUDE.md to reflect that both superseded skills are kept in sync rather than stubbed. * refactor: slim four medium SKILL.md files into references/ Continue the P2 pattern on the next tier of skills — move option catalogs, per-provider/adapter detail, and repeated EXTEND.md path boilerplate into their own references so SKILL.md stays focused on the decision flow. - baoyu-comic: 380→297 (art/tone/preset tables → auto-selection.md; Step 7 expanded detail → workflow.md) - baoyu-infographic: 312→207 (layouts/styles/combinations/keywords → gallery.md; ASCII box tables → markdown tables) - baoyu-format-markdown: 376→296 (title + summary generation → title-summary.md; ASCII box tables → markdown tables) - baoyu-url-to-markdown: 334→169 (quality gate + recovery → quality-gate.md; adapters + media download → adapters.md) * chore: sync deprecated skills with their replacements Per project policy, baoyu-xhs-images and baoyu-image-gen are kept functional alongside the active skills they were superseded by. Sync their SKILL.md bodies and references/ to the slimmed baoyu-image-cards and baoyu-imagine versions respectively, so cross-cutting fixes stay consistent. Only the frontmatter (name, description, version, homepage) differs — content is identical. - baoyu-xhs-images: 657→281 (synced with baoyu-image-cards + new confirmation.md, gallery.md) - baoyu-image-gen: 408→231 (synced with baoyu-imagine + new providers/, usage-examples.md) * refactor: collapse EXTEND.md boilerplate into priority tables Replace the dual bash/powershell existence-check blocks and ASCII box art with a single markdown priority table across nine SKILL.md files. The runtime-neutral phrasing removes shell-specific snippets without losing the priority semantics. * fix: address refactor-skills branch review findings - image-gen: restore EXTEND.md paths to baoyu-image-gen (were pointing at baoyu-imagine) and mark descriptions of both deprecated skills as [Deprecated]. - xhs-images: sync neon/warm palettes with image-cards to add the "do not render color names/hex as visible text" safety sentence. - infographic: restore Layout Gallery (21), Style Gallery (21), Recommended Combinations, and Keyword Shortcuts inline (previous refactor split them out but SKILL.md still depended on them), and add the missing references/config/first-time-setup.md + preferences-schema.md. - image-cards / xhs-images / slide-deck / format-markdown: restore the sections that got over-slimmed into references/ (galleries, presets, dimensions, auto-selection, style x layout matrix, title/summary flow) and drop the now-empty shell files. - docs/image-generation-tools.md: note that backend skills themselves (baoyu-imagine, baoyu-image-gen, baoyu-danger-gemini-web) are exempt from the ## Image Generation Tools section requirement. * feat(image-gen): sync Z.AI GLM-Image provider from baoyu-imagine Add Z.AI as a full provider in the deprecated baoyu-image-gen skill so it stays in sync with baoyu-imagine's provider list. - new scripts/providers/zai.ts + zai.test.ts (verbatim port; test factory trimmed to match image-gen's CliArgs shape). - types.ts: "zai" added to Provider union and default_model. - main.ts: rate-limit defaults, provider help text, env var help, --provider validation, loadProviderModule, detectProvider auto-detect chain, getModelForProvider, YAML parser allow-lists. - references/config: Q2e Z.AI model question + zai slot in the preferences schema and batch.provider_limits. Scope is intentionally limited to the Z.AI chain; unrelated drift between image-gen and imagine (OpenAI image-API dialect, aspectRatioSource, imageSizeSource) is left alone. * docs: align inline-convention wording and note backend-skill exemption - docs/user-input-tools.md: fix stale "links here" wording so it matches the inline convention already enforced everywhere else. - CLAUDE.md §Image Generation Tools: inline the backend-skill exemption so readers don't need to cross-reference docs/image-generation-tools.md.
215 lines
7.2 KiB
Markdown
215 lines
7.2 KiB
Markdown
---
|
|
name: baoyu-danger-x-to-markdown
|
|
description: Converts X (Twitter) tweets and articles to markdown with YAML front matter. Uses reverse-engineered API requiring user consent. Use when user mentions "X to markdown", "tweet to markdown", "save tweet", or provides x.com/twitter.com URLs for conversion.
|
|
version: 1.56.1
|
|
metadata:
|
|
openclaw:
|
|
homepage: https://github.com/JimLiu/baoyu-skills#baoyu-danger-x-to-markdown
|
|
requires:
|
|
anyBins:
|
|
- bun
|
|
- npx
|
|
---
|
|
|
|
# X to Markdown
|
|
|
|
Converts X content to markdown:
|
|
- Tweets/threads → Markdown with YAML front matter
|
|
- X Articles → Full content extraction
|
|
|
|
## User Input Tools
|
|
|
|
When this skill prompts the user, follow this tool-selection rule (priority order):
|
|
|
|
1. **Prefer built-in user-input tools** exposed by the current agent runtime — e.g., `AskUserQuestion`, `request_user_input`, `clarify`, `ask_user`, or any equivalent.
|
|
2. **Fallback**: if no such tool exists, emit a numbered plain-text message and ask the user to reply with the chosen number/answer for each question.
|
|
3. **Batching**: if the tool supports multiple questions per call, combine all applicable questions into a single call; if only single-question, ask them one at a time in priority order.
|
|
|
|
Concrete `AskUserQuestion` references below are examples — substitute the local equivalent in other runtimes.
|
|
|
|
## Script Directory
|
|
|
|
Scripts located in `scripts/` subdirectory.
|
|
|
|
**Path Resolution**:
|
|
1. `{baseDir}` = this SKILL.md's directory
|
|
2. Script path = `{baseDir}/scripts/main.ts`
|
|
3. 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
|
|
|
|
```bash
|
|
# macOS
|
|
cat ~/Library/Application\ Support/baoyu-skills/x-to-markdown/consent.json
|
|
|
|
# Linux
|
|
cat ~/.local/share/baoyu-skills/x-to-markdown/consent.json
|
|
```
|
|
|
|
**Step 2**: If `accepted: true` and `disclaimerVersion: "1.0"` → print warning and proceed:
|
|
```
|
|
Warning: Using reverse-engineered X API. Accepted on: <acceptedAt>
|
|
```
|
|
|
|
**Step 3**: If missing or version mismatch → display disclaimer:
|
|
```
|
|
DISCLAIMER
|
|
|
|
This tool uses a reverse-engineered X API, NOT official.
|
|
|
|
Risks:
|
|
- May break if X changes API
|
|
- No guarantees or support
|
|
- Possible account restrictions
|
|
- Use at your own risk
|
|
|
|
Accept terms and continue?
|
|
```
|
|
|
|
Use `AskUserQuestion` with options: "Yes, I accept" | "No, I decline"
|
|
|
|
**Step 4**: On accept → create consent file:
|
|
```json
|
|
{
|
|
"version": 1,
|
|
"accepted": true,
|
|
"acceptedAt": "<ISO timestamp>",
|
|
"disclaimerVersion": "1.0"
|
|
}
|
|
```
|
|
|
|
**Step 5**: On decline → output "User declined. Exiting." and stop.
|
|
|
|
## Preferences (EXTEND.md)
|
|
|
|
Check EXTEND.md in priority order — the first one found wins:
|
|
|
|
| Priority | Path | Scope |
|
|
|----------|------|-------|
|
|
| 1 | `.baoyu-skills/baoyu-danger-x-to-markdown/EXTEND.md` | Project |
|
|
| 2 | `${XDG_CONFIG_HOME:-$HOME/.config}/baoyu-skills/baoyu-danger-x-to-markdown/EXTEND.md` | XDG |
|
|
| 3 | `$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](references/config/first-time-setup.md)
|
|
|
|
### Supported Keys
|
|
|
|
| Key | Default | Values | Description |
|
|
|-----|---------|--------|-------------|
|
|
| `download_media` | `ask` | `ask` / `1` / `0` | `ask` = prompt each time, `1` = always download, `0` = never |
|
|
| `default_output_dir` | empty | path or empty | Default output directory (empty = `./x-to-markdown/`) |
|
|
|
|
**Value priority**:
|
|
1. CLI arguments (`--download-media`, `-o`)
|
|
2. EXTEND.md
|
|
3. Skill defaults
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
${BUN_X} {baseDir}/scripts/main.ts <url>
|
|
${BUN_X} {baseDir}/scripts/main.ts <url> -o output.md
|
|
${BUN_X} {baseDir}/scripts/main.ts <url> --download-media
|
|
${BUN_X} {baseDir}/scripts/main.ts <url> --json
|
|
```
|
|
|
|
## Options
|
|
|
|
| Option | Description |
|
|
|--------|-------------|
|
|
| `<url>` | Tweet or article URL |
|
|
| `-o <path>` | 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
|
|
|
|
- `https://x.com/<user>/status/<id>`
|
|
- `https://twitter.com/<user>/status/<id>`
|
|
- `https://x.com/i/article/<id>`
|
|
|
|
## Output
|
|
|
|
```markdown
|
|
---
|
|
url: "https://x.com/user/status/123"
|
|
author: "Name (@user)"
|
|
tweetCount: 3
|
|
coverImage: "https://pbs.twimg.com/media/example.jpg"
|
|
---
|
|
|
|
Content...
|
|
```
|
|
|
|
**File structure**: `x-to-markdown/{username}/{tweet-id}/{content-slug}.md`
|
|
|
|
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 |
|
|
|---------|----------|
|
|
| `1` (always) | Run script with `--download-media` flag |
|
|
| `0` (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
|
|
2. Check saved markdown for remote media URLs (`https://` in image/video links)
|
|
3. **If no remote media found** → done, no prompt needed
|
|
4. **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`, `X_CT0`
|
|
2. **Chrome login** (fallback): Auto-opens Chrome, caches cookies locally
|
|
|
|
## Extension Support
|
|
|
|
Custom configurations via EXTEND.md. See **Preferences** section for paths and supported options.
|