---

description: Search, read, analyze, and automate Xiaohongshu (小红书) content via CLI allowed-tools: Bash, Read, Write, Glob, Grep

OpenClaw / ClawHub metadata (clawhub install redbook)

name: redbook version: 0.5.0 metadata: openclaw: requires: bins: - redbook install: - kind: node package: "@lucasygu/redbook" bins: [redbook] os: [macos] homepage: https://github.com/lucasygu/redbook tags:

• xiaohongshu
• social-media
• analytics
• content-ops

---

Redbook — Xiaohongshu CLI

Use the redbook CLI to search notes, read content, analyze creators, automate engagement, and research topics on Xiaohongshu (小红书/RED).

OpenClaw users: Install via clawhub install redbook or npm install -g @lucasygu/redbook.

Usage

/redbook search "AI编程"              # Search notes
/redbook read <url>                   # Read a note
/redbook user <userId>                # Creator profile
/redbook analyze <userId>             # Full creator analysis (profile + posts)

Quick Reference

| Intent | Command | |--------|---------| | Search notes | redbook search "keyword" --json | | Read a note | redbook read <url> --json | | Get comments | redbook comments <url> --json --all | | Creator profile | redbook user <userId> --json | | Creator's posts | redbook user-posts <userId> --json | | Browse feed | redbook feed --json | | Search hashtags | redbook topics "keyword" --json | | Analyze viral note | redbook analyze-viral <url> --json | | Extract content template | redbook viral-template <url1> <url2> --json | | Post a comment | redbook comment <url> --content "text" | | Reply to comment | redbook reply <url> --comment-id <id> --content "text" | | Batch reply (preview) | redbook batch-reply <url> --strategy questions --dry-run | | Like a note | redbook like <url> | | Unlike a note | redbook like <url> --undo | | List favorites | redbook favorites --json or redbook favorites <userId> --json | | Collect a note | redbook collect <url> | | Remove from collection | redbook uncollect <url> | | List followers | redbook followers <userId> --json | | List following | redbook following <userId> --json | | Delete own note | redbook delete <url> | | Check note health | redbook health --json or redbook health --all --json | | List user boards | redbook boards or redbook boards <userId> --json | | List album notes | redbook board <board-url> or redbook board <boardId> --json | | Render markdown to cards | redbook render content.md --style xiaohongshu | | Publish image note | redbook post --title "..." --body "..." --images img.jpg | | Check connection | redbook whoami |

Always add --json when parsing output programmatically. Without it, output is human-formatted text.

---

XHS Platform Signals

XHS is not Twitter or Instagram. These platform-specific engagement ratios reveal content type and audience behavior.

Collect/Like Ratio (collected_count / liked_count)

XHS's "collect" (收藏) is a save-for-later mechanic — users build personal reference libraries. This ratio is the strongest signal of content utility.

| Ratio | Classification | Meaning | |-------|---------------|---------| | >40% | 工具型 (Reference) | Tutorial, checklist, template — users bookmark for reuse | | 20–40% | 认知型 (Insight) | Thought-provoking but not saved for later | | <20% | 娱乐型 (Entertainment) | Consumed and forgotten — engagement is passive |

Comment/Like Ratio (comment_count / liked_count)

Measures how much a note triggers conversation.

| Ratio | Classification | Meaning | |-------|---------------|---------| | >15% | 讨论型 (Discussion) | Debate, sharing experiences, asking questions | | 5–15% | 正常互动 (Normal) | Typical engagement pattern | | <5% | 围观型 (Passive) | Users like but don't engage further |

Share/Like Ratio (share_count / liked_count)

Measures social currency — whether users share to signal identity or help others.

| Ratio | Meaning | |-------|---------| | >10% | 社交货币 — people share to signal taste, identity, or help friends | | <10% | Content consumed individually, not forwarded |

Search Sort Semantics

| Sort | What It Reveals | |------|----------------| | --sort popular | Proven ceiling — the best a keyword can do | | --sort latest | Content velocity — how much is being posted now | | --sort general | Algorithm-weighted blend (default) |

Content Form Dynamics

| Form | Tendency | |------|----------| | 图文 (image-text, type: "normal") | Higher collect rate — users save reference content | | 视频 (video, type: "video") | Higher like rate — easier to consume passively |

---

Analysis Modules

Each module is a composable building block. Combine them for different analysis depths.

Module A: Keyword Engagement Matrix

Answers: Which keywords have the highest engagement ceiling? Which are saturated vs. underserved?

Commands:

redbook search "keyword1" --sort popular --json
redbook search "keyword2" --sort popular --json
# Repeat for each keyword in your list

Fields to extract from each result's items[]:

• items[].note_card.interact_info.liked_count — likes (may use Chinese numbers: "1.5万" = 15,000)
• items[].note_card.interact_info.collected_count — collects
• items[].note_card.interact_info.comment_count — comments
• items[].note_card.user.nickname — author

How to interpret:

• Top1 ceiling = items[0] likes — the best-performing note for this keyword. This is the proven demand signal.
• Top10 average = mean likes across items[0..9] — how well an average top note does.
• A high Top1 but low Top10 avg means one outlier dominates; hard to compete.
• A high Top10 avg means consistent demand; easier to break in.

Output: Keyword × engagement table ranked by Top1 ceiling.

| Keyword | Top1 Likes | Top10 Avg | Top1 Collects | Collect/Like | |---------|-----------|-----------|---------------|-------------| | keyword1 | 12,000 | 3,200 | 5,400 | 45% | | keyword2 | 8,500 | 4,100 | 1,200 | 14% |

---

Module B: Cross-Topic Heatmap

Answers: Which topic × scene intersections have demand? Where are the content gaps?

Commands:

# Combine base topic with scene/angle keywords
redbook search "base topic + scene1" --sort popular --json
redbook search "base topic + scene2" --sort popular --json
redbook search "base topic + scene3" --sort popular --json

Fields to extract: Same as Module A — Top1 liked_count for each combination.

How to interpret:

• High Top1 = proven demand for this intersection
• Zero or very low results = content gap (opportunity or no demand — check if the combination makes sense)
• Compare across scenes to find which angles resonate most with the base topic

Output: Base × Scene heatmap.

             scene1    scene2    scene3    scene4
base topic   ████ 8K   ██ 2K     ████ 12K  ░░ 200

---

Module C: Engagement Signal Analysis

Answers: What type of content is each keyword? Reference, insight, or entertainment?

Commands: Use search results from Module A, or for a single note:

redbook analyze-viral "<noteUrl>" --json

Fields to extract:

• From search results: compute ratios from interact_info fields
• From analyze-viral: use pre-computed engagement.collectToLikeRatio, engagement.commentToLikeRatio, engagement.shareToLikeRatio

How to interpret: Apply the ratio benchmarks from XHS Platform Signals above.

Output: Per-keyword or per-note classification.

| Keyword | Collect/Like | Comment/Like | Type | |---------|-------------|-------------|------| | keyword1 | 45% | 8% | 工具型 + 正常互动 | | keyword2 | 12% | 22% | 娱乐型 + 讨论型 |

---

Module D: Creator Discovery & Profiling

Answers: Who are the key creators in this niche? What are their strategies?

Commands:

# 1. Collect unique user_ids from search results across keywords
#    Extract from items[].note_card.user.user_id

# 2. For each creator:
redbook user "<userId>" --json
redbook user-posts "<userId>" --json

Fields to extract:

• From user: interactions[] where type === "fans" → follower count
• From user-posts: notes[].interact_info.liked_count for all posts → compute avg, median, max
• From user-posts: notes[].display_title → content patterns, posting frequency

How to interpret:

• Avg vs. Median likes: Large gap means viral outliers inflate the average. Median is the "true" baseline.
• Max / Median ratio: >5× means they've had breakout hits. Study those notes specifically.
• Post frequency: Count notes to estimate posting cadence. Prolific creators (>3/week) vs. quality-focused (<1/week).

Output: Creator comparison table.

| Creator | Followers | Avg Likes | Median | Max | Posts | Style | |---------|----------|-----------|--------|-----|-------|-------| | @creator1 | 12万 | 3,200 | 1,800 | 45,000 | 89 | Tutorial | | @creator2 | 5.4万 | 8,100 | 6,500 | 22,000 | 34 | Story |

---

Module E: Content Form Breakdown

Answers: Do image-text or video notes perform better for this topic?

Commands:

redbook search "keyword" --type image --sort popular --json
redbook search "keyword" --type video --sort popular --json

Fields to extract:

• Compare Top1 and Top10 avg liked_count and collected_count between the two result sets
• Note the type field: "normal" = image-text, "video" = video

Output: Form × engagement table.

| Form | Top1 Likes | Top10 Avg | Collect/Like | |------|-----------|-----------|-------------| | 图文 | 8,000 | 2,400 | 42% | | 视频 | 15,000 | 5,100 | 18% |

---

Module F: Opportunity Scoring

Answers: Which keywords should I target? Where is the best effort-to-reward ratio?

Input: Keyword matrix from Module A.

Scoring logic:

• Demand = Top1 likes ceiling (proven audience size)
• Competition = density of high-engagement results (how many notes in Top10 have >1K likes)
• Score = Demand × (1 / Competition density)

Tier thresholds (based on Top1 likes):

| Tier | Top1 Likes | Meaning | |------|-----------|---------| | S | >100,000 (10万+) | Massive demand — hard to compete but huge upside | | A | 20,000–100,000 | Strong demand — competitive but winnable | | B | 5,000–20,000 | Moderate demand — good for growing accounts | | C | <5,000 | Niche — low competition, low ceiling |

Output: Tiered keyword list.

| Tier | Keyword | Top1 | Competition | Opportunity | |------|---------|------|-------------|------------| | A | keyword1 | 45K | Medium (6/10 >1K) | High | | B | keyword3 | 12K | Low (2/10 >1K) | Very High | | S | keyword2 | 120K | High (10/10 >1K) | Medium |

---

Module G: Audience Inference

Answers: Who is the audience for this niche? What do they want?

Input: Engagement ratios from Module C + comment themes from analyze-viral + content patterns.

Fields to extract from analyze-viral JSON:

• comments.themes[] — recurring phrases and keywords from comment section
• comments.questionRate — % of comments that are questions (learning intent)
• engagement.collectToLikeRatio — save behavior signals intent
• hook.hookPatterns[] — what title patterns attract this audience

Inference rules:

• High collect rate + high question rate → learning-oriented audience (students, professionals)
• High comment rate + emotional themes → community-oriented audience (sharing experiences)
• High share rate → aspiration-oriented audience (lifestyle, identity signaling)
• Comment language patterns → age/education signals (formal = older, slang = younger)

Output: Audience persona summary — demographics, intent, content preferences.

---

Module H: Content Brainstorm

Answers: What specific content should I create, backed by data?

Input: Opportunity scores (Module F) + audience persona (Module G) + heatmap gaps (Module B).

For each content idea, specify:

• Target keyword — from opportunity scoring
• Hook angle — based on hookPatterns that work for this niche
• Content type — 工具型/认知型/娱乐型 based on what the audience wants
• Form — 图文 or 视频 based on Module E
• Engagement target — realistic based on Top10 avg for this keyword
• Competitive reference — specific note URL that proves this angle works

Output: Ranked content ideas with data backing.

| # | Keyword | Hook Angle | Type | Target Likes | Reference | |---|---------|-----------|------|-------------|-----------| | 1 | keyword3 | "N个方法..." (List) | 工具型 图文 | 5K+ | [top note URL] | | 2 | keyword1 | "为什么..." (Question) | 认知型 视频 | 10K+ | [top note URL] |

---

Module I: Comment Operations

Answers: Which comments deserve a reply? What is the comment quality distribution?

Commands:

# 1. Fetch all comments
redbook comments "<noteUrl>" --all --json

# 2. Preview reply candidates (dry run)
redbook batch-reply "<noteUrl>" --strategy questions --dry-run --json

# 3. Execute replies with template (5 min delay with ±30% jitter)
redbook batch-reply "<noteUrl>" --strategy questions \
  --template "感谢提问！关于{content}，..." \
  --max 10

Fields to extract from --dry-run JSON:

• candidates[].commentId — target comments
• candidates[].isQuestion — boolean, detected question
• candidates[].likes — engagement signal
• candidates[].hasSubReplies — whether already answered
• skipped — how many comments were filtered out
• totalComments — total fetched

Strategies:

• questions — replies to comments ending with ？ or ? (learning-oriented audience)
• top-engaged — replies to highest-liked comments (maximum visibility)
• all-unanswered — replies to comments with no existing sub-replies (fill gaps)

How to interpret:

• High question rate (>15%) = audience is learning-oriented → reply to build authority
• High top-engaged comments (>100 likes) = reply to visible comments for maximum reach
• Many unanswered comments = engagement gap, opportunity to increase reply rate

Safety: Hard cap 30 replies per batch, minimum 3-minute delay with ±30% jitter (default 5 min), --dry-run by default (no template = preview only), immediate stop on captcha. See Rate Limits & Safety for details.

Output: Reply plan table with candidate comments, strategy match reason, and status.

---

Module J: Viral Replication

Answers: What structural template can I extract from successful notes to guide new content creation?

Commands:

# 1. Find top notes for a keyword
redbook search "keyword" --sort popular --json

# 2. Extract structural template from 2-3 top performers
redbook viral-template "<url1>" "<url2>" "<url3>" --json

Fields to extract from viral-template JSON:

• dominantHookPatterns[] — hook types appearing in majority of notes
• titleStructure.commonPatterns[] — specific title formula
• titleStructure.avgLength — target title length
• bodyStructure.lengthRange — target word count [min, max]
• bodyStructure.paragraphRange — target paragraph count
• engagementProfile.type — reference/insight/entertainment
• audienceSignals.commonThemes[] — what the audience talks about

How to interpret:

• Consistent hook patterns across notes = proven formula for this niche
• Narrow body length range = audience has clear content length preference
• High collect/like in profile = audience saves content → create reference material
• Common comment themes = topics to address in new content

Composition with other modules:

• Uses Module A results to identify top URLs for template extraction
• Feeds into Module H (Content Brainstorm) as structural constraint
• Uses Module C classification to validate engagement profile

Output: Content template spec — the structural skeleton for content creation. An LLM (via the composed workflow) uses this template to generate actual title, body, hashtags, and cover image prompt.

---

Module K: Engagement Automation

Answers: How should I manage ongoing engagement with my audience?

This module is a workflow that composes Modules I and J with human oversight.

Workflow:

1. Monitor — redbook comments "<myNoteUrl>" --all --json to fetch recent comments
2. Filter — redbook batch-reply --strategy questions --dry-run to identify reply candidates
3. Review — Human reviews dry-run output (or LLM reviews with persona guidelines)
4. Execute — redbook batch-reply --strategy questions --template "..." --max 10
5. Report — Summary of replies sent, errors encountered, rate limit status

Safety rules:

• Always --dry-run first, human approval before execution
• Maximum 30 replies per session (hard cap)
• Minimum 3-minute delay between replies, default 5 minutes, with ±30% random jitter
• Never reply to the same comment twice (check hasSubReplies)
• Stop immediately on captcha — do not retry
• See Rate Limits & Safety for XHS risk control thresholds

Anti-spam guidelines:

• Vary reply templates across batches
• Limit to 1-2 batch runs per note per day
• Prioritize quality (targeted strategy) over quantity
• Uniform timing patterns trigger bot detection — jitter is applied automatically

---

Module L: Card Rendering

Answers: How do I turn markdown content into Xiaohongshu-ready image cards?

Commands:

# Render markdown to styled PNG cards
redbook render content.md --style xiaohongshu

# Custom style and output directory
redbook render content.md --style dark --output-dir ./cards

# JSON output (for programmatic use)
redbook render content.md --json

Input: Markdown file with YAML frontmatter:

---
emoji: "🚀"
title: "5个AI效率技巧"
subtitle: "Claude Code 实战"
---

## 技巧一：...
Content here...

---

## 技巧二：...
More content...

Output: cover.png + card_1.png, card_2.png, ... in the same directory.

Card specs:

• Size: 1080×1440 (3:4 ratio, standard XHS image)
• DPR: 2 (retina quality, actual output 2160×2880)
• Styles: purple, xiaohongshu, mint, sunset, ocean, elegant, dark

Pagination modes:

• auto (default) — smart split on heading/paragraph boundaries using character-count heuristic
• separator — manual split on --- in markdown

How to interpret:

• Uses the user's existing Chrome for rendering (via puppeteer-core) — no browser download needed
• Purely offline — no XHS API or cookies required
• Output images are ready for redbook post --images cover.png card_1.png ...

Dependencies: Requires puppeteer-core and marked (optional, install with npm install -g puppeteer-core marked).

Composition with other modules:

• Pairs with Module H (Content Brainstorm) — generate content ideas, write markdown, render to cards
• Pairs with Module J (Viral Replication) — extract template, write content matching the template, render
• Output feeds into redbook post --images for publishing

---

Module M: Note Health Check (限流检测)

Answers: Are any of my notes being secretly rate-limited by XHS?

XHS assigns a hidden level field to each note in the creator backend API. This level controls recommendation distribution but is never shown in the UI. Your note may look "normal" while secretly receiving zero recommendations.

Commands:

# Check all notes (first page)
redbook health

# Check all pages
redbook health --all

# JSON output for programmatic use
redbook health --all --json

Level definitions:

| Level | Status | Meaning | |-------|--------|---------| | 4 | 🟢 Normal | Full recommendation distribution | | 2-3 | 🟡 Baseline | Basically normal, minor constraints | | 1 | ⚪ New | Under review (new post) | | -1 | 🔴 Soft limit | Mild throttling, decreased recommendations | | -5 to -101 | 🔴 Moderate | Moderate throttling, minimal promotion | | -102 | ⛔ Severe | Irreversible — must delete and repost |

Additional checks:

• Sensitive word detection — flags titles containing automation/AI keywords (自动化, AI生成, 批量, etc.)
• Tag count warning — flags notes with >5 hashtags (risk factor)

How to interpret:

• Level -1 or below = your note is being throttled. Consider editing or deleting + reposting.
• Level -102 = irreversible. Delete the note and create fresh content.
• Sensitive word hits = risky title keywords that may trigger throttling. Rephrase.
• Excessive tags = potential spam signal. Use 3-5 targeted tags.

Output: Terminal dashboard with color-coded distribution summary, limited notes list, and risk factor warnings.

Discovery credit: @xxx111god — xhs-note-health-checker

---

Composed Workflows

Combine modules for different analysis depths.

Quick Topic Scan (~5 min)

Modules: A → C → F

Search 3–5 keywords, classify engagement type, rank opportunities. Good for quickly validating whether a niche is worth deeper research.

Content Planning

Modules: A → B → E → F → H

Build keyword matrix, map topic × scene intersections, check content form performance, score opportunities, brainstorm specific content ideas.

Creator Competitive Analysis

Modules: A → D

Find who dominates a niche and study their content strategy, posting frequency, and engagement patterns.

Full Niche Analysis

Modules: A → B → C → D → E → F → G → H

The comprehensive playbook — keyword landscape, cross-topic heatmap, engagement signals, creator profiles, content form analysis, opportunity scoring, audience personas, and data-backed content ideas.

Single Note Deep-Dive

Command: redbook analyze-viral "<url>" --json

No module composition needed — analyze-viral returns hook analysis, engagement ratios, comment themes, author baseline comparison, and a 0-100 viral score in one call.

Viral Pattern Research → Content Template

# 1. Find top notes
redbook search "keyword" --sort popular --json

# 2. Extract template from top 3 notes (replaces manual synthesis)
redbook viral-template "<url1>" "<url2>" "<url3>" --json

viral-template automates what previously required manual synthesis across analyze-viral results. It outputs a ContentTemplate JSON that captures dominant hooks, body structure ranges, engagement profile, and audience signals.

Reply Management

Modules: I

Single-module workflow for managing comment engagement on your notes. Use batch-reply --dry-run to audit, then execute with a template.

Content Replication

Modules: A → J → H → L

Keyword research → viral template extraction → data-backed content brainstorm → render to image cards. The template provides structural constraints that guide Module H's content ideas. Module L renders the final markdown to XHS-ready PNGs.

Content Creation End-to-End

Modules: A → J → H → L → post

The full pipeline: research keywords → extract viral template → brainstorm content → write markdown → render to styled image cards → publish via redbook post --images cover.png card_1.png ...

Account Health Monitoring

Modules: M

Run redbook health --all periodically to catch throttled notes early. If level drops below 1, investigate the note's content for policy violations. Combine with Module I to check if throttled notes still have unanswered comments worth replying to.

Full Operations

Modules: A → C → I → J → K → M

Comprehensive automation playbook — keyword analysis, engagement classification, comment operations, viral replication templates, and engagement automation workflow.

---

Rate Limits & Safety

XHS enforces aggressive anti-spam (风控) that detects automated behavior through device fingerprinting, activity ratio monitoring, and timing pattern analysis. The CLI applies safe defaults based on platform research.

Safe Thresholds

| Action | Safe Interval | CLI Default | Hard Cap | |--------|--------------|-------------|----------| | Post a note | 3-4 hours (2-3 notes/day max) | N/A (manual) | — | | Comment | ≥3 minutes | N/A (manual) | — | | Reply | ≥3 minutes | N/A (manual) | — | | Batch reply delay | ≥3 minutes | 5 min ±30% jitter | — | | Batch reply count | — | 10 | 30 |

Anti-Detection Measures

• Timing jitter: ±30% random variation on all batch delays. Uniform intervals are a bot signature.
• Hard caps: Maximum 30 replies per batch (down from 50). No override.
• Rate limit warnings: post, comment, and reply commands display safe interval reminders after each action.
• Captcha circuit breaker: Batch operations stop immediately on captcha (NeedVerify).

What Triggers Risk Control

• Uniform timing — replying at exact 3-second intervals flags bot detection
• High frequency — >50 interactions/minute across any action type
• Activity ratio anomaly — more comments than post views signals inauthentic behavior
• Device fingerprint mismatch — XHS fingerprints 21 hardware parameters

Best Practices for Agents

1. Always --dry-run first, review candidates, then execute
2. Use the default 5-minute delay — do not override --delay below 180000 (3 min)
3. Limit batch runs to 1-2 per note per day
4. Vary reply templates between batches
5. Space post commands 3-4 hours apart (2-3 notes/day maximum)

---

API vs Browser Limitations

The following operations work reliably via API:

• Reading: search, notes, comments, user profiles, feed, favorites
• Writing: top-level comments, comment replies, collect/uncollect notes
• Analysis: viral scoring, template extraction, batch reply planning

The following operations are unreliable via API (frequently trigger captcha):

• Publishing notes (use --private for higher success rate)
• Bulk operations at very high frequency

The following operations require browser automation (not supported by this CLI):

• Captcha solving, real-time notifications
• Like/follow (heavy anti-automation enforcement)
• DM/private messaging
• Cover image generation (use external tools like Gemini/DALL-E)

---

Command Details

redbook search <keyword>

Search for notes by keyword. Returns note titles, URLs, likes, author info.

redbook search "Claude Code教程" --json
redbook search "AI编程" --sort popular --json        # Sort: general, popular, latest
redbook search "Cursor" --type image --json           # Type: all, video, image
redbook search "MCP Server" --page 2 --json           # Pagination

Options:

• --sort <type>: general (default), popular, latest
• --type <type>: all (default), video, image
• --page <n>: Page number (default: 1)

redbook read <url>

Read a note's full content — title, body text, images, likes, comments count.

redbook read "https://www.xiaohongshu.com/explore/abc123" --json

Accepts full URLs or short note IDs. Falls back to HTML scraping if API returns captcha.

redbook comments <url>

Get comments on a note. Use --all to fetch all pages.

redbook comments "https://www.xiaohongshu.com/explore/abc123" --json
redbook comments "https://www.xiaohongshu.com/explore/abc123" --all --json

redbook user <userId>

Get a creator's profile — nickname, bio, follower count, note count, likes received.

redbook user "5a1234567890abcdef012345" --json

The userId is the hex string from the creator's profile URL.

redbook user-posts <userId>

List all notes posted by a creator. Returns titles, URLs, likes, timestamps.

redbook user-posts "5a1234567890abcdef012345" --json

redbook feed

Browse the recommendation feed.

redbook feed --json

redbook topics <keyword>

Search for topic hashtags. Useful for finding trending topics to attach to posts.

redbook topics "Claude Code" --json

redbook favorites [userId]

List a user's collected (bookmarked) notes. Defaults to the current logged-in user when no userId is provided.

redbook favorites --json                        # Your own favorites
redbook favorites "5a1234567890abcdef" --json   # Another user's favorites
redbook favorites --all --json                  # Fetch all pages

Options:

• --all: Fetch all pages of favorites (default: first page only)

Note: Other users' favorites are only visible if they haven't set their collection to private.

redbook collect <url>

Collect (bookmark) a note to your favorites.

redbook collect "https://www.xiaohongshu.com/explore/abc123"

redbook uncollect <url>

Remove a note from your collection.

redbook uncollect "https://www.xiaohongshu.com/explore/abc123"

redbook analyze-viral <url>

Analyze why a viral note works. Returns a deterministic viral score (0–100).

redbook analyze-viral "https://www.xiaohongshu.com/explore/abc123" --json
redbook analyze-viral "https://www.xiaohongshu.com/explore/abc123" --comment-pages 5

Options:

• --comment-pages <n>: Comment pages to fetch (default: 3, max: 10)

JSON output structure: Returns { note, score, hook, content, visual, engagement, comments, relative, fetchedAt }.

• score.overall (0–100) — composite of hook (20) + engagement (20) + relative (20) + content (20) + comments (20)
• hook.hookPatterns[] — detected title patterns (Identity Hook, Emotion Word, Number Hook, Question, etc.)
• engagement — likes, comments, collects, shares + ratios (collectToLikeRatio, commentToLikeRatio, shareToLikeRatio)
• relative.viralMultiplier — this note's likes / author's median likes
• relative.isOutlier — true if viralMultiplier > 3
• comments.themes[] — top recurring keyword phrases from comments

redbook viral-template <url> [url2] [url3]

Extract a reusable content template from 1-3 viral notes. Analyzes each note (same pipeline as analyze-viral) and synthesizes common structural patterns.

redbook viral-template "<url1>" "<url2>" "<url3>" --json
redbook viral-template "<url1>" --comment-pages 5 --json

Options:

• --comment-pages <n>: Comment pages to fetch per note (default: 3, max: 10)

JSON output structure: Returns { dominantHookPatterns, titleStructure, bodyStructure, engagementProfile, audienceSignals, sourceNotes, generatedAt }.

• dominantHookPatterns[] — hook types appearing in majority of input notes
• titleStructure.avgLength — average title length across notes
• bodyStructure.lengthRange — [min, max] body length
• engagementProfile.type — "reference" / "insight" / "entertainment"
• audienceSignals.commonThemes[] — merged comment themes across notes

redbook comment <url>

Post a top-level comment on a note.

redbook comment "<noteUrl>" --content "Great post!" --json

Options:

• --content <text> (required): Comment text

redbook reply <url>

Reply to a specific comment on a note.

redbook reply "<noteUrl>" --comment-id "<commentId>" --content "Thanks for asking!" --json

Options:

• --comment-id <id> (required): Comment ID to reply to (from comments --json output)
• --content <text> (required): Reply text

redbook batch-reply <url>

Reply to multiple comments using a filtering strategy. Always preview with --dry-run first.

# Preview which comments match the strategy
redbook batch-reply "<noteUrl>" --strategy questions --dry-run --json

# Execute replies with a template (default 5 min delay with jitter)
redbook batch-reply "<noteUrl>" --strategy questions \
  --template "感谢提问！{content}" --max 10

Options:

• --strategy <name>: questions (default), top-engaged, all-unanswered
• --template <text>: Reply template with {author}, {content} placeholders
• --max <n>: Max replies (default: 10, hard cap: 30)
• --delay <ms>: Delay between replies in ms (default: 300000 / 5 min, min: 180000 / 3 min). ±30% random jitter applied automatically.
• --dry-run: Preview candidates without posting (default when no template)

Safety: Stops immediately on captcha. No template = dry-run only. Delays include random jitter to avoid uniform timing patterns that trigger XHS bot detection.

redbook render <file>

Render a markdown file with YAML frontmatter into styled PNG image cards. Uses the user's existing Chrome installation — no browser download needed.

redbook render content.md --style xiaohongshu
redbook render content.md --style dark --output-dir ./cards
redbook render content.md --pagination separator --json

Options:

• --style <name>: purple, xiaohongshu (default), mint, sunset, ocean, elegant, dark
• --pagination <mode>: auto (default), separator (split on ---)
• --output-dir <dir>: Output directory (default: same as input file)
• --width <n>: Card width in px (default: 1080)
• --height <n>: Card height in px (default: 1440)
• --dpr <n>: Device pixel ratio (default: 2)

Requires: puppeteer-core and marked (npm install -g puppeteer-core marked). Does NOT require XHS cookies — purely offline rendering.

Override Chrome path: Set CHROME_PATH environment variable if Chrome is not in the standard location.

redbook whoami

Check connection status. Verifies cookies are valid and shows the logged-in user.

redbook whoami

redbook post (Limited)

Publish an image note. Frequently triggers captcha (type=124) on the creator API. Image upload works, but the publish step is unreliable. For posting, consider using browser automation instead.

redbook post --title "标题" --body "正文" --images cover.png --json
redbook post --title "测试" --body "..." --images img.png --private --json

Options:

• --title <title>: Note title (required)
• --body <body>: Note body text (required)
• --images <paths...>: Image file paths (required, at least one)
• --topic <keyword>: Search and attach a topic hashtag
• --private: Publish as private note

Global Options

All commands accept:

• --cookie-source <browser>: chrome (default), safari, firefox
• --chrome-profile <name>: Chrome profile directory name (e.g., "Profile 1"). Auto-discovered if omitted.
• --json: Output as JSON

---

Technical Reference

xsec_token — Required for Reading & Sharing Notes

The XHS API requires a valid xsec_token to fetch note content. Without it, read, comments, and analyze-viral return {}.

The same token is also required for shareable URLs. Any https://www.xiaohongshu.com/explore/<id> URL without ?xsec_token=...&xsec_source=... is 302-redirected by XHS's anti-scrape layer to https://www.xiaohongshu.com/404/sec_*?source=xhs_sec_server&originalUrl=.... This affects anyone who clicks the URL — Safari, iOS link previews, agent action buttons, etc.

webUrl — use this (since v0.7.0):

Every note-returning command (feed, search, user-posts, favorites, board, read, post) now includes a webUrl field with the token baked in and the correct xsec_source. Consumers should use webUrl directly — do not construct URLs by hand.

redbook feed --json | jq '.items[0].webUrl'
# => "https://www.xiaohongshu.com/explore/<id>?xsec_token=<t>&xsec_source=pc_feed"

xsec_source is set per-command: pc_feed, pc_search, pc_user, pc_board, pc_share.

Key rules:

1. Tokens expire. A URL with ?xsec_token=... from a previous session will return {}. Never cache or reuse old URLs.
2. search and feed always return fresh tokens. Every item includes a valid xsec_token + a pre-built webUrl.
3. noteId alone returns {}. Running redbook read <noteId> without a token almost always fails.

The correct workflow — always search first:

# WRONG — stale URL or bare noteId, will likely return {}
redbook read "689da7b0000000001b0372c6" --json
redbook read "https://www.xiaohongshu.com/explore/689da7b0?xsec_token=OLD_TOKEN" --json

# RIGHT — search first, then use the fresh URL with token
redbook search "AI编程" --sort popular --json
# Extract the webUrl from search results, then:
redbook read "<webUrl from search result>" --json

For agents: Prefer webUrl from the response. When only a bare noteId is available, search first to obtain a fresh token, then use the returned webUrl.

Commands that need xsec_token: read, comments, analyze-viral Commands that do NOT need xsec_token: search, user, user-posts, feed, whoami, topics

Chinese Number Formats in API Responses

The XHS API returns abbreviated numbers with Chinese unit suffixes:

| API value | Actual number | |-----------|---------------| | "1.5万" | 15,000 | | "2.4万" | 24,000 | | "1.2亿" | 120,000,000 | | "115" | 115 |

万 = ×10,000. 亿 = ×100,000,000. Numbers under 10,000 are plain integers as strings.

The analyze-viral command handles this automatically. When parsing --json output manually, watch for these suffixes in interact_info fields (liked_count, collected_count, etc.).

Error Handling

| Error | Meaning | Fix | |-------|---------|-----| | {} empty response | Missing or expired xsec_token | Search first to get a fresh token | | "No 'a1' cookie" | Not logged into XHS in browser | Log into xiaohongshu.com in Chrome | | "Session expired" | Cookie too old | Re-login in Chrome | | "NeedVerify" / captcha | Anti-bot triggered | Wait and retry, or reduce request frequency | | "IP blocked" (300012) | Rate limited | Wait or switch network |

---

Output Format Guidance

When producing analysis reports, use these formats:

Data tables: Markdown tables with exact field mappings. Always include the metric unit.

Heatmaps: ASCII bar charts for cross-topic comparison:

             职场    生活    教育    创业
AI编程       ████ 8K  ██ 2K   ████ 12K ░░ 200
Claude Code  ██ 3K    ░░ 100  ██ 4K    █ 1K

Creator comparison: Structured table with both quantitative metrics and qualitative style assessment.

Final reports: Use this section order:

1. Market Overview (demand signals, content velocity)
2. Keyword Landscape (engagement matrix, opportunity tiers)
3. Cross-Topic Heatmap (topic × scene intersections)
4. Audience Persona (demographics, intent, preferences)
5. Competitive Landscape (creator profiles, strategy patterns)
6. Content Opportunities (tiered recommendations with data backing)
7. Content Ideas (specific hooks, angles, targets)

Programmatic API

import { XhsClient } from "@lucasygu/redbook";
import { loadCookies } from "@lucasygu/redbook/cookies";

const cookies = await loadCookies("chrome");
const client = new XhsClient(cookies);

const results = await client.searchNotes("AI编程", 1, 20, "popular");
const topics = await client.searchTopics("Claude Code");

Requirements

• Node.js >= 22
• Logged into xiaohongshu.com in Chrome (or Safari/Firefox with --cookie-source)
• macOS (cookie extraction uses native keychain access)
• For card rendering only: puppeteer-core and marked (npm install -g puppeteer-core marked). Uses your existing Chrome — no additional browser download.

redbook — 小红书命令行工具

小红书 CLI 工具：搜索笔记、阅读内容、分析博主、发布图文。使用浏览器 Cookie 认证，无需 API Key。

English | 中文

最快上手方式

把这段话发给你的 AI 助手（Claude Code、Cursor、Codex、Windsurf、OpenClaw 等）：

"帮我用 npm 安装 @lucasygu/redbook 这个小红书 CLI 工具，然后运行 redbook whoami 验证是否能正常连接。GitHub 地址：https://github.com/lucasygu/redbook"

OpenClaw 用户也可以直接：clawhub install redbook

AI 会自动完成安装、验证连接、处理可能的 Cookie 问题。你只需要确保已在 Chrome 中登录 xiaohongshu.com。

安装完成后，试试："帮我分析'AI编程'这个话题在小红书上的竞争格局" —— AI 会自动搜索关键词、分析互动数据、发现头部博主、给出内容建议。

安装

npm install -g @lucasygu/redbook
# 或通过 ClawHub（OpenClaw 生态）
clawhub install redbook

需要 Node.js >= 22。支持 macOS、Windows、Linux。使用 Chrome 浏览器的 Cookie —— 请先在 Chrome 中登录 xiaohongshu.com。

安装后运行 redbook whoami 验证连接。CLI 会自动检测所有 Chrome 配置文件，找到你的小红书登录状态。

• macOS —— 如果遇到钥匙串弹窗，请点击"始终允许"
• Windows —— Chrome 127+ 使用了 App-Bound Encryption，CLI 会自动启动 Chrome headless 模式读取 Cookie（需要先关闭 Chrome）。如果自动提取失败，可以用 --cookie-string 手动传入

能做什么

• 话题研究 —— 搜索关键词，分析哪些话题有流量、哪些是蓝海
• 竞品分析 —— 找到头部博主，对比粉丝量、互动数据、内容风格
• 爆款拆解 —— 分析爆款笔记的标题钩子、互动比例、评论主题
• 爆款模板 —— 从多篇爆款笔记提取内容模板（标题结构、正文结构、钩子模式）
• 限流检测 —— 检测笔记是否被隐形限流（通过创作者后台 API 的隐藏 level 字段）
• 收藏专辑 —— 查看收藏专辑内容，分析专辑内的笔记
• 收藏管理 —— 查看收藏列表、收藏/取消收藏笔记（支持自己和其他用户的公开收藏）
• 评论管理 —— 发评论、回复评论、按策略批量回复（问题优先 / 高赞优先 / 未回复优先）
• 图文卡片 —— Markdown 渲染为小红书风格的 PNG 图文卡片（7 种配色主题）
• 内容策划 —— 基于数据发现内容机会，生成有数据支撑的选题建议
• 受众洞察 —— 从互动信号推断目标用户画像

通过 AI 助手使用时，这些工作流可以自动串联完成。直接使用 CLI 时，每个命令也可以独立运行。

快速开始

# 检查连接
redbook whoami

# 搜索笔记
redbook search "AI编程" --sort popular

# 阅读笔记
redbook read https://www.xiaohongshu.com/explore/abc123

# 获取评论
redbook comments https://www.xiaohongshu.com/explore/abc123 --all

# 浏览推荐页
redbook feed

# 查看博主信息
redbook user <userId>
redbook user-posts <userId>

# 搜索话题标签
redbook topics "Claude Code"

# 查看收藏（默认当前用户）
redbook favorites --json
redbook favorites <userId> --json --all

# 收藏/取消收藏
redbook collect "<noteUrl>"
redbook uncollect "<noteUrl>"

# 分析爆款笔记
redbook analyze-viral https://www.xiaohongshu.com/explore/abc123

# 从多篇爆款提取内容模板
redbook viral-template "<url1>" "<url2>" "<url3>" --json

# 发评论
redbook comment "<noteUrl>" --content "写得好！"

# 回复评论
redbook reply "<noteUrl>" --comment-id "<id>" --content "感谢提问！"

# 按策略批量回复（先预览再执行）
redbook batch-reply "<noteUrl>" --strategy questions --dry-run
redbook batch-reply "<noteUrl>" --strategy questions --template "感谢！{content}" --max 10

# 查看收藏专辑
redbook boards                          # 列出自己的专辑
redbook boards <userId>                 # 列出他人的专辑
redbook board "https://www.xiaohongshu.com/board/abc123"
redbook board abc123 --json

# 检测笔记限流状态
redbook health
redbook health --all --json

# 将 Markdown 渲染为图文卡片（需要可选依赖）
redbook render content.md --style xiaohongshu
redbook render content.md --style dark --output-dir ./cards

# 发布图文笔记
redbook post --title "标题" --body "正文内容" --images cover.png
redbook post --title "测试" --body "..." --images img.png --private

命令一览

| 命令 | 说明 | |------|------| | whoami | 查看当前登录账号 | | search <关键词> | 搜索笔记 | | read <url> | 阅读单篇笔记 | | comments <url> | 获取笔记评论 | | user <userId> | 查看用户资料 | | user-posts <userId> | 列出用户所有笔记 | | feed | 获取推荐页内容 | | post | 发布图文笔记（易触发验证码，详见下方说明） | | topics <关键词> | 搜索话题/标签 | | favorites [userId] | 查看收藏笔记列表（默认当前用户） | | collect <url> | 收藏（书签）笔记 | | uncollect <url> | 取消收藏笔记 | | health | 检测笔记隐形限流（通过创作者后台隐藏 level 字段） | | boards [userId] | 列出用户的收藏专辑（默认当前用户） | | board <url> | 查看收藏专辑内容（接受专辑 URL 或 ID） | | analyze-viral <url> | 分析爆款笔记（钩子、互动、结构） | | viral-template <url...> | 从 1-3 篇爆款笔记提取内容模板 | | comment <url> | 发表评论 | | reply <url> | 回复指定评论 | | batch-reply <url> | 按策略批量回复评论（支持预览模式） | | render <文件> | Markdown 渲染为小红书图文卡片 PNG（需可选依赖） |

通用选项

| 选项 | 说明 | 默认值 | |------|------|--------| | --cookie-source <浏览器> | Cookie 来源浏览器（chrome, safari, firefox） | chrome | | --chrome-profile <名称> | Chrome 配置文件目录名（如 "Profile 1"），默认自动检测 | 自动 | | --cookie-string <cookies> | 手动传入 Cookie 字符串："a1=值; web_session=值"（从 Chrome DevTools 复制） | 无 | | --json | JSON 格式输出 | false |

搜索选项

| 选项 | 说明 | 默认值 | |------|------|--------| | --sort <类型> | general（综合）、popular（热门）、latest（最新） | general | | --type <类型> | all（全部）、video（视频）、image（图文） | all | | --page <页码> | 页码 | 1 |

分析选项（analyze-viral / viral-template）

| 选项 | 说明 | 默认值 | |------|------|--------| | --comment-pages <n> | 获取评论页数 | 3 |

批量回复选项（batch-reply）

| 选项 | 说明 | 默认值 | |------|------|--------| | --strategy <策略> | questions（提问）、top-engaged（高赞）、all-unanswered（未回复） | questions | | --template <模板> | 回复模板，支持 {author}, {content} 占位符 | 无（预览模式） | | --max <数量> | 最大回复数（上限 30） | 10 | | --delay <毫秒> | 回复间隔（最小 180000ms/3分钟），自动添加 ±30% 随机抖动 | 300000（5分钟） | | --dry-run | 只预览不发送 | 无模板时自动开启 |

⚠️ 风控安全： 小红书检测均匀时间间隔的自动化行为。回复间隔已自动添加 ±30% 随机抖动，避免触发机器人检测。建议每天每篇笔记最多批量回复 1-2 次。

渲染选项（render）

将 Markdown 文件渲染为小红书风格的 PNG 图文卡片。使用本机 Chrome 渲染，无需额外下载浏览器。

| 选项 | 说明 | 默认值 | |------|------|--------| | --style <名称> | 配色：purple, xiaohongshu, mint, sunset, ocean, elegant, dark | xiaohongshu | | --pagination <模式> | 分页：auto（自动拆分）、separator（按 --- 拆分） | auto | | --output-dir <目录> | 输出目录 | 与输入文件同目录 | | --width <像素> | 卡片宽度 | 1080 | | --height <像素> | 卡片高度 | 1440 | | --dpr <倍率> | 设备像素比 | 2 |

可选依赖： 需要安装 puppeteer-core 和 marked：

npm install -g puppeteer-core marked

发布选项（post）

发布功能目前容易触发验证码（type=124）。图片上传正常，但发布步骤经常被拦截。如需发布笔记，建议使用浏览器自动化。

| 选项 | 说明 | |------|------| | --title <标题> | 笔记标题（必填） | | --body <正文> | 笔记正文（必填） | | --images <路径...> | 图片文件路径（必填） | | --topic <关键词> | 附加话题标签 | | --private | 发布为私密笔记 |

常见问题

| 问题 | 解决方案 | |------|----------| | No 'a1' cookie found | 在 Chrome 中登录 xiaohongshu.com，然后重试 | | Windows 上 -101 错误 | Chrome 127+ 的 App-Bound Encryption 导致。先关闭 Chrome，再运行命令（CLI 会自动启动 Chrome headless 读取 Cookie）。如仍失败，用 --cookie-string 手动传入 | | Windows --cookie-string 用法 | Chrome 按 F12 → Application → Cookies → xiaohongshu.com，复制 a1 和 web_session 的值：redbook whoami --cookie-string "a1=值; web_session=值" | | macOS 钥匙串弹窗 | 输入密码后点击"始终允许"，CLI 需要读取 Chrome 的加密 Cookie | | 多个 Chrome 配置文件 | CLI 自动扫描所有配置文件（macOS / Windows / Linux）。如需指定：--chrome-profile "Profile 1" | | 使用 Brave/Arc 等浏览器 | 尝试 --cookie-source safari，或在 Chrome 中登录 |

工作原理

redbook 从 Chrome 读取小红书的登录 Cookie，然后用 TypeScript 实现的签名算法对 API 请求签名。

三层 Cookie 提取策略：

1. sweet-cookie（快速路径）—— 直接读取 Chrome 的 SQLite 数据库，macOS 上即开即用
2. CDP 回退（Windows 自动触发）—— 启动 Chrome headless，通过 DevTools Protocol 读取 Cookie，绕过 Chrome 127+ 的 App-Bound Encryption
3. --cookie-string（手动兜底）—— 从 Chrome DevTools 复制 Cookie 字符串，任何平台通用

两套签名系统：

• 主 API（edith.xiaohongshu.com）—— 读取：搜索、推荐页、笔记、评论、用户资料。使用 144 字节 x-s 签名（v4.3.1）
• 创作者 API（creator.xiaohongshu.com）—— 写入：上传图片、发布笔记。使用 AES-128-CBC 签名

分析模块（A-M）

内置 13 个可组合的分析模块，覆盖从关键词研究到内容发布的完整工作流：

| 模块 | 功能 | |------|------| | A. 关键词矩阵 | 分析各关键词的互动天花板和竞争密度 | | B. 跨话题热力图 | 发现话题 × 场景的内容空白 | | C. 互动信号分析 | 分类内容类型（工具型 / 认知型 / 娱乐型） | | D. 博主画像 | 对比头部博主的粉丝、互动、风格 | | E. 内容形式分析 | 图文 vs. 视频的表现对比 | | F. 机会评分 | 按性价比排序关键词 | | G. 受众推断 | 从互动信号推断用户画像 | | H. 选题策划 | 数据驱动的内容创意 | | I. 评论运营 | 按策略筛选和批量回复评论 | | J. 爆款复刻 | 从爆款笔记提取内容模板 | | K. 互动自动化 | 组合 I + J 的自动化运营工作流 | | L. 图文卡片 | Markdown → 小红书风格 PNG 图文卡片（7 种配色） | | M. 限流检测 | 通过创作者后台隐藏 level 字段检测笔记限流状态 |

详见 SKILL.md 的模块文档和组合工作流。

AI 助手集成

Claude Code

安装后自动注册为 Claude Code 技能。在 Claude Code 中使用 /redbook 命令：

/redbook search "AI编程"                        # 搜索笔记
/redbook read <url>                             # 阅读笔记
/redbook user <userId>                          # 查看博主
/redbook analyze-viral <url>                    # 分析爆款笔记

你可以直接用自然语言下达复杂任务：

• "分析'AI编程'在小红书的竞争格局，找出蓝海关键词"
• "对比这三个博主的内容策略和互动数据"
• "拆解这篇爆款笔记，告诉我为什么火了"
• "帮我回复这篇笔记下面的提问评论"

Claude 会自动组合多个命令，解析 JSON 数据，输出结构化分析报告。

OpenClaw / ClawHub

官方支持 OpenClaw 和 ClawHub 生态。通过 ClawHub 安装：

clawhub install redbook

安装后在 OpenClaw 中可直接使用所有 redbook 命令。SKILL.md 同时兼容 Claude Code 和 OpenClaw 两个生态。

编程接口

import { XhsClient } from "@lucasygu/redbook";
import { loadCookies } from "@lucasygu/redbook/cookies";

const cookies = await loadCookies("chrome");
const client = new XhsClient(cookies);

const results = await client.searchNotes("AI编程", 1, 20, "popular");
const topics = await client.searchTopics("Claude Code");

致谢

签名算法移植自以下开源项目（MIT 协议）：

• Cloxl/xhshow — 主 API 签名（x-s, x-s-common）
• Spider_XHS — 创作者 API 签名
• ReaJason/xhs — API 端点参考

Cookie 提取使用 @steipete/sweet-cookie。

限流检测灵感来自 jzOcb/xhs-note-health-checker（@xxx111god 发现了创作者后台 API 的隐藏 level 字段）。

免责声明

本工具使用非官方 API。小红书可能随时更改或封锁这些接口。请合理使用，风险自负。本项目与小红书无任何关联。

---

English

A fast CLI tool for Xiaohongshu (小红书 / RED) — search notes, read content, analyze creators, and publish posts. Uses browser cookie auth (no API key needed).

Easiest way to get started

Paste this to your AI coding agent (Claude Code, Cursor, Codex, Windsurf, OpenClaw, etc.):

"Install the @lucasygu/redbook Xiaohongshu CLI tool via npm and run redbook whoami to verify it works. Repo: https://github.com/lucasygu/redbook"

OpenClaw users can also run: clawhub install redbook

The agent will handle installation, verify the connection, and troubleshoot any cookie issues. Just make sure you're logged into xiaohongshu.com in Chrome first.

Once installed, try: "Analyze the competitive landscape for 'AI编程' on Xiaohongshu" — the agent will search keywords, analyze engagement data, profile top creators, and suggest content opportunities.

Install

npm install -g @lucasygu/redbo