mirror of https://github.com/jackwener/OpenCLI.git synced 2026-09-14 18:25:42 +08:00

Files

T

Mikey Zhou 5731881d59 feat: add bilibili/comments, xiaohongshu/comments commands + rate-limiter plugin docs (#457 )

* feat: add bilibili/comments, xiaohongshu/comments, and rate-limiter plugin docs

- bilibili/comments: fetch top-level replies via /x/v2/reply/main with WBI signing
  (bvid → aid resolution + signed params, no DOM dependency)
- xiaohongshu/comments: DOM extraction from note detail page with login-wall detection
  and correct handling of 0-like counts (XHS shows "赞" text instead of "0")
- docs/advanced/rate-limiter-plugin.md: documents the onAfterExecute hook pattern
  and shows a plug-and-play rate limiter that adds random sleep between platform
  commands to reduce bot-detection risk

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix(xiaohongshu): allow empty comments results

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: jackwener <jakevingoo@gmail.com>

2026-03-26 22:10:12 +08:00

3.1 KiB

Raw Permalink Blame History

Rate Limiter Plugin

An optional plugin that adds a random sleep between browser-based commands to reduce the risk of platform rate-limiting or bot detection.

Install

opencli plugin install github:jackwener/opencli-plugin-rate-limiter

Or copy the example below into ~/.opencli/plugins/rate-limiter/ to use it locally without installing from GitHub.

What it does

After every command targeting a browser platform (xiaohongshu, weibo, bilibili, douyin, tiktok, …), the plugin sleeps for a random duration — 5–30 seconds by default — before returning control to the caller.

Configuration

Variable	Default	Description
`OPENCLI_RATE_MIN`	`5`	Minimum sleep in seconds
`OPENCLI_RATE_MAX`	`30`	Maximum sleep in seconds
`OPENCLI_NO_RATE`	—	Set to `1` to disable entirely (local dev)

# Shorter delays for light scraping
OPENCLI_RATE_MIN=3 OPENCLI_RATE_MAX=10 opencli xiaohongshu search "AI眼镜"

# Skip delays when iterating locally
OPENCLI_NO_RATE=1 opencli bilibili comments BV1WtAGzYEBm

Local installation (without GitHub)

Create the plugin directory:

mkdir -p ~/.opencli/plugins/rate-limiter

Create ~/.opencli/plugins/rate-limiter/package.json:
```
{ "type": "module" }
```

Create ~/.opencli/plugins/rate-limiter/index.js:

import { onAfterExecute } from '@jackwener/opencli/hooks'

const BROWSER_DOMAINS = [
  'xiaohongshu', 'weibo', 'bilibili', 'douyin', 'tiktok',
  'instagram', 'twitter', 'youtube', 'zhihu', 'douban',
  'jike', 'weixin', 'xiaoyuzhou',
]

onAfterExecute(async (ctx) => {
  if (process.env.OPENCLI_NO_RATE === '1') return

  const site = ctx.command?.split('/')?.[0] ?? ''
  if (!BROWSER_DOMAINS.includes(site)) return

  const min = Number(process.env.OPENCLI_RATE_MIN ?? 5)
  const max = Number(process.env.OPENCLI_RATE_MAX ?? 30)
  const ms = Math.floor(Math.random() * (max - min + 1) + min) * 1000

  process.stderr.write(`[rate-limiter] ${site}: sleeping ${(ms / 1000).toFixed(0)}s\n`)
  await new Promise(r => setTimeout(r, ms))
})

Verify it loaded:

OPENCLI_NO_RATE=1 opencli xiaohongshu search "test" 2>&1 | grep rate-limiter
# → (no output — plugin loaded but rate limit skipped)

opencli xiaohongshu search "test" 2>&1 | grep rate-limiter
# → [rate-limiter] xiaohongshu: sleeping 12s

Writing your own plugin

Plugins are plain JS/TS files in ~/.opencli/plugins/<name>/. A plugin file must export a hook registration call that matches the pattern onStartup(, onBeforeExecute(, or onAfterExecute( — opencli's discovery engine uses this pattern to identify hook files vs. command files.

// ~/.opencli/plugins/my-plugin/index.js
import { onAfterExecute } from '@jackwener/opencli/hooks'

onAfterExecute(async (ctx) => {
  // ctx.command — e.g. "bilibili/comments"
  // ctx.args    — coerced command arguments
  // ctx.error   — set if the command threw
  console.error(`[my-plugin] finished: ${ctx.command}`)
})

See hooks.ts for the full HookContext type.

3.1 KiB Raw Permalink Blame History Unescape Escape