@jackwener/opencli 1.1.0 → 1.2.0

package/dist/types.d.ts

@@ -4,35 +4,56 @@
  * All pipeline steps and CLI adapters should use this interface
  * instead of `any` for browser interactions.
  */
+export interface BrowserCookie {
+    name: string;
+    value: string;
+    domain: string;
+    path?: string;
+    secure?: boolean;
+    httpOnly?: boolean;
+    expirationDate?: number;
+}
+export interface SnapshotOptions {
+    interactive?: boolean;
+    compact?: boolean;
+    maxDepth?: number;
+    raw?: boolean;
+    viewportExpand?: number;
+    maxTextLength?: number;
+}
+export interface WaitOptions {
+    text?: string;
+    time?: number;
+    timeout?: number;
+}
+export interface ScreenshotOptions {
+    format?: 'png' | 'jpeg';
+    quality?: number;
+    fullPage?: boolean;
+    path?: string;
+}
+export interface BrowserSessionInfo {
+    workspace?: string;
+    connected?: boolean;
+    [key: string]: unknown;
+}
 export interface IPage {
-    goto(url: string): Promise<void>;
+    goto(url: string, options?: {
+        waitUntil?: 'load' | 'none';
+        settleMs?: number;
+    }): Promise<void>;
     evaluate(js: string): Promise<any>;
     getCookies(opts?: {
         domain?: string;
         url?: string;
-    }): Promise<Array<{
-        name: string;
-        value: string;
-        domain: string;
-        path?: string;
-        secure?: boolean;
-        httpOnly?: boolean;
-        expirationDate?: number;
-    }>>;
-    snapshot(opts?: {
-        interactive?: boolean;
-        compact?: boolean;
-        maxDepth?: number;
-        raw?: boolean;
-    }): Promise<any>;
+    }): Promise<BrowserCookie[]>;
+    snapshot(opts?: SnapshotOptions): Promise<any>;
     click(ref: string): Promise<void>;
     typeText(ref: string, text: string): Promise<void>;
     pressKey(key: string): Promise<void>;
-    wait(options: number | {
-        text?: string;
-        time?: number;
-        timeout?: number;
-    }): Promise<void>;
+    scrollTo(ref: string): Promise<any>;
+    getFormState(): Promise<any>;
+    wait(options: number | WaitOptions): Promise<void>;
     tabs(): Promise<any>;
     closeTab(index?: number): Promise<void>;
     newTab(): Promise<void>;
@@ -46,10 +67,5 @@ export interface IPage {
     }): Promise<void>;
     installInterceptor(pattern: string): Promise<void>;
     getInterceptedRequests(): Promise<any[]>;
-    screenshot(options?: {
-        format?: 'png' | 'jpeg';
-        quality?: number;
-        fullPage?: boolean;
-        path?: string;
-    }): Promise<string>;
+    screenshot(options?: ScreenshotOptions): Promise<string>;
 }

package/dist/validate.js

@@ -9,6 +9,12 @@ const KNOWN_STEP_NAMES = new Set([
     'select', 'map', 'filter', 'sort', 'limit',
     'intercept', 'tap',
 ]);
+function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+function getErrorMessage(error) {
+    return error instanceof Error ? error.message : String(error);
+}
 export function validateClisWithTarget(dirs, target) {
     const results = [];
     let errors = 0;
@@ -45,7 +51,7 @@ function validateYamlFile(filePath) {
     try {
         const raw = fs.readFileSync(filePath, 'utf-8');
         const def = yaml.load(raw);
-        if (!def || typeof def !== 'object') {
+        if (!isRecord(def)) {
             errors.push('Not a valid YAML object');
             return { path: filePath, errors, warnings };
         }
@@ -75,7 +81,7 @@ function validateYamlFile(filePath) {
         }
     }
     catch (e) {
-        errors.push(`YAML parse error: ${e.message}`);
+        errors.push(`YAML parse error: ${getErrorMessage(e)}`);
     }
     return { path: filePath, errors, warnings };
 }

package/docs/.vitepress/config.mts

@@ -1,7 +1,7 @@
 import { defineConfig } from 'vitepress'
 
 export default defineConfig({
-  base: '/',
+  base: '/docs/',
   title: 'OpenCLI',
   description: 'Make any website or Electron App your CLI — AI-powered, account-safe, self-healing.',
 
@@ -31,6 +31,7 @@ export default defineConfig({
                 { text: 'Installation', link: '/guide/installation' },
                 { text: 'Browser Bridge', link: '/guide/browser-bridge' },
                 { text: 'Troubleshooting', link: '/guide/troubleshooting' },
+                { text: 'Plugins', link: '/guide/plugins' },
               ],
             },
           ],
@@ -54,12 +55,22 @@ export default defineConfig({
                 { text: 'YouTube', link: '/adapters/browser/youtube' },
                 { text: 'Xueqiu', link: '/adapters/browser/xueqiu' },
                 { text: 'V2EX', link: '/adapters/browser/v2ex' },
+                { text: 'Bloomberg', link: '/adapters/browser/bloomberg' },
                 { text: 'LinkedIn', link: '/adapters/browser/linkedin' },
                 { text: 'Coupang', link: '/adapters/browser/coupang' },
                 { text: 'BOSS Zhipin', link: '/adapters/browser/boss' },
                 { text: 'Ctrip', link: '/adapters/browser/ctrip' },
                 { text: 'Reuters', link: '/adapters/browser/reuters' },
                 { text: 'SMZDM', link: '/adapters/browser/smzdm' },
+                { text: 'Jike', link: '/adapters/browser/jike' },
+                { text: 'Jimeng', link: '/adapters/browser/jimeng' },
+                { text: 'LINUX DO', link: '/adapters/browser/linux-do' },
+                { text: 'Chaoxing', link: '/adapters/browser/chaoxing' },
+                { text: 'Grok', link: '/adapters/browser/grok' },
+                { text: 'WeRead', link: '/adapters/browser/weread' },
+                { text: 'Douban', link: '/adapters/browser/douban' },
+                { text: 'Sina Blog', link: '/adapters/browser/sinablog' },
+                { text: 'Substack', link: '/adapters/browser/substack' },
               ],
             },
             {
@@ -67,11 +78,17 @@ export default defineConfig({
               collapsed: false,
               items: [
                 { text: 'HackerNews', link: '/adapters/browser/hackernews' },
-                { text: 'GitHub', link: '/adapters/browser/github' },
+                { text: 'Dev.to', link: '/adapters/browser/devto' },
                 { text: 'BBC', link: '/adapters/browser/bbc' },
                 { text: 'Apple Podcasts', link: '/adapters/browser/apple-podcasts' },
                 { text: 'Xiaoyuzhou', link: '/adapters/browser/xiaoyuzhou' },
                 { text: 'Yahoo Finance', link: '/adapters/browser/yahoo-finance' },
+                { text: 'arXiv', link: '/adapters/browser/arxiv' },
+                { text: 'Barchart', link: '/adapters/browser/barchart' },
+                { text: 'Hugging Face', link: '/adapters/browser/hf' },
+                { text: 'Sina Finance', link: '/adapters/browser/sinafinance' },
+                { text: 'Stack Overflow', link: '/adapters/browser/stackoverflow' },
+                { text: 'Wikipedia', link: '/adapters/browser/wikipedia' },
               ],
             },
             {
@@ -85,9 +102,6 @@ export default defineConfig({
                 { text: 'ChatWise', link: '/adapters/desktop/chatwise' },
                 { text: 'Notion', link: '/adapters/desktop/notion' },
                 { text: 'Discord', link: '/adapters/desktop/discord' },
-                { text: 'Feishu', link: '/adapters/desktop/feishu' },
-                { text: 'WeChat', link: '/adapters/desktop/wechat' },
-                { text: 'NeteaseMusic', link: '/adapters/desktop/neteasemusic' },
               ],
             },
           ],
@@ -137,7 +151,7 @@ export default defineConfig({
                 { text: '快速开始', link: '/zh/guide/getting-started' },
                 { text: '安装', link: '/zh/guide/installation' },
                 { text: 'Browser Bridge', link: '/zh/guide/browser-bridge' },
-                { text: '问题排查', link: '/zh/guide/troubleshooting' },
+                { text: '插件', link: '/zh/guide/plugins' },
               ],
             },
           ],
@@ -154,7 +168,6 @@ export default defineConfig({
               text: '开发者指南',
               items: [
                 { text: '贡献指南', link: '/zh/developer/contributing' },
-                { text: '测试', link: '/zh/developer/testing' },
               ],
             },
           ],

package/docs/adapters/browser/arxiv.md

@@ -0,0 +1,27 @@
+# arXiv
+
+**Mode**: 🌐 Public · **Domain**: `arxiv.org`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli arxiv search` | Search arXiv papers |
+| `opencli arxiv paper` | Get arXiv paper details by ID |
+
+## Usage Examples
+
+```bash
+# Search for papers
+opencli arxiv search "transformer attention" --limit 10
+
+# Get paper details by arXiv ID
+opencli arxiv paper 2301.00001
+
+# JSON output
+opencli arxiv search "LLM" -f json
+```
+
+## Prerequisites
+
+- No browser required — uses public arXiv API

package/docs/adapters/browser/barchart.md

@@ -0,0 +1,33 @@
+# Barchart
+
+**Mode**: 🔐 Browser · **Domain**: `barchart.com`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli barchart quote` | Stock quote with price, volume, and key metrics |
+| `opencli barchart options` | Options chain with greeks, IV, volume, and open interest |
+| `opencli barchart greeks` | Options greeks overview (IV, delta, gamma, theta, vega) |
+| `opencli barchart flow` | Unusual options activity / options flow |
+
+## Usage Examples
+
+```bash
+# Get stock quote
+opencli barchart quote AAPL
+
+# View options chain
+opencli barchart options TSLA
+
+# Options greeks overview
+opencli barchart greeks NVDA
+
+# Unusual options flow
+opencli barchart flow --limit 20 -f json
+```
+
+## Prerequisites
+
+- Chrome running and able to open `barchart.com`
+- [Browser Bridge extension](/guide/browser-bridge) installed

package/docs/adapters/browser/bilibili.md

@@ -25,6 +25,15 @@
 # Quick start
 opencli bilibili hot --limit 5
 
+# Search videos
+opencli bilibili search 黑神话 --limit 10
+
+# Read one creator's videos
+opencli bilibili user-videos 2 --limit 10
+
+# Fetch subtitles
+opencli bilibili subtitle BV1xx411c7mD --lang zh-CN
+
 # JSON output
 opencli bilibili hot -f json
 

package/docs/adapters/browser/bloomberg.md

@@ -0,0 +1,70 @@
+# Bloomberg
+
+**Mode**: 🌐 / 🔐 Mixed · **Domains**: `feeds.bloomberg.com`, `www.bloomberg.com`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli bloomberg main` | Bloomberg homepage top stories from RSS |
+| `opencli bloomberg markets` | Bloomberg Markets top stories from RSS |
+| `opencli bloomberg economics` | Bloomberg Economics top stories from RSS |
+| `opencli bloomberg industries` | Bloomberg Industries top stories from RSS |
+| `opencli bloomberg tech` | Bloomberg Tech top stories from RSS |
+| `opencli bloomberg politics` | Bloomberg Politics top stories from RSS |
+| `opencli bloomberg businessweek` | Bloomberg Businessweek top stories from RSS |
+| `opencli bloomberg opinions` | Bloomberg Opinion top stories from RSS |
+| `opencli bloomberg feeds` | List the RSS feed aliases used by the adapter |
+| `opencli bloomberg news <link>` | Read a standard Bloomberg story/article page and return title, summary, media links, and article text |
+
+## What works today
+
+- RSS-backed listing commands work without a browser:
+  - `main`
+  - `markets`
+  - `economics`
+  - `industries`
+  - `tech`
+  - `politics`
+  - `businessweek`
+  - `opinions`
+  - `feeds`
+- `bloomberg news` works on standard Bloomberg story/article pages that expose `#__NEXT_DATA__` and are accessible to your current Chrome session.
+
+## Current limitations
+
+- Audio pages and some other non-standard Bloomberg URLs may fail.
+- Some Bloomberg pages can return bot-protection or access-gated responses instead of article data.
+- This adapter is for data retrieval/extraction only. It does **not** bypass Bloomberg paywall, login, entitlement, or other access checks.
+
+## Usage Examples
+
+```bash
+# List supported RSS feed aliases
+opencli bloomberg feeds
+
+# Fetch Bloomberg homepage headlines
+opencli bloomberg main --limit 5
+
+# Fetch a section feed as JSON
+opencli bloomberg tech --limit 3 -f json
+
+# Read a standard article page
+opencli bloomberg news https://www.bloomberg.com/news/articles/2026-03-19/example -f json
+
+# Relative article paths also work
+opencli bloomberg news /news/articles/2026-03-19/example
+```
+
+## Prerequisites
+
+- RSS commands do not require Chrome.
+- `bloomberg news` requires:
+  - Chrome running
+  - a Chrome session that can already access the target Bloomberg article page
+  - the [Browser Bridge extension](/guide/browser-bridge)
+
+## Notes
+
+- RSS commands support `--limit` with a maximum of 20 items.
+- If `bloomberg news` fails on a page from RSS, try a different standard story/article link first; not every Bloomberg URL in feeds is a normal article page.

package/docs/adapters/browser/chaoxing.md

@@ -0,0 +1,39 @@
+# 超星学习通 (Chaoxing)
+
+**Mode**: 🔐 Browser · **Domain**: `mooc2-ans.chaoxing.com`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli chaoxing assignments` | 学习通作业列表 |
+| `opencli chaoxing exams` | 学习通考试列表 |
+
+## Usage Examples
+
+```bash
+# List all assignments
+opencli chaoxing assignments --limit 20
+
+# Filter exams by course name
+opencli chaoxing exams --course "高等数学"
+
+# Filter exams by status
+opencli chaoxing exams --status ongoing
+
+# JSON output
+opencli chaoxing assignments -f json
+```
+
+### Options
+
+| Option | Description |
+|--------|-------------|
+| `--course` | Filter by course name (fuzzy match) |
+| `--status` | Filter by status: `all`, `upcoming`, `ongoing`, `finished` |
+| `--limit` | Max number of results (default: 20) |
+
+## Prerequisites
+
+- Chrome running and **logged into** mooc2-ans.chaoxing.com
+- [Browser Bridge extension](/guide/browser-bridge) installed

package/docs/adapters/browser/devto.md

@@ -0,0 +1,35 @@
+# Dev.to
+
+**Mode**: 🌐 Public · **Domain**: `dev.to`
+
+Fetch the latest and greatest developer articles from the DEV community without needing an API key.
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli devto top` | Top DEV.to articles of the day |
+| `opencli devto tag` | Latest articles for a specific tag |
+| `opencli devto user` | Recent articles from a specific user |
+
+## Usage Examples
+
+```bash
+# Top articles today
+opencli devto top --limit 5
+
+# Articles by tag (positional argument)
+opencli devto tag javascript
+opencli devto tag python --limit 20
+
+# Articles by a specific author
+opencli devto user ben
+opencli devto user thepracticaldev --limit 5
+
+# JSON output
+opencli devto top -f json
+```
+
+## Prerequisites
+
+- No browser required — uses the public DEV.to API

package/docs/adapters/browser/douban.md

@@ -0,0 +1,38 @@
+# 豆瓣 (Douban)
+
+**Mode**: 🔐 Browser (Cookie) · **Domain**: `douban.com`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli douban movie-hot` | 豆瓣电影热门榜单 |
+| `opencli douban book-hot` | 豆瓣图书热门榜单 |
+| `opencli douban search` | 搜索豆瓣电影、图书或音乐 |
+
+## Usage Examples
+
+```bash
+# 电影热门
+opencli douban movie-hot --limit 10
+
+# 图书热门
+opencli douban book-hot --limit 10
+
+# 搜索电影
+opencli douban search "流浪地球"
+
+# 搜索图书
+opencli douban search --type book "三体"
+
+# 搜索音乐
+opencli douban search --type music "周杰伦"
+
+# JSON output
+opencli douban movie-hot -f json
+```
+
+## Prerequisites
+
+- Chrome logged into `douban.com`
+- Browser Bridge extension installed

package/docs/adapters/browser/facebook.md

@@ -0,0 +1,36 @@
+# Facebook
+
+**Mode**: 🔐 Browser · **Domain**: `facebook.com`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli facebook profile` | Get user/page profile info |
+| `opencli facebook notifications` | Get recent notifications |
+| `opencli facebook feed` | Get news feed posts |
+| `opencli facebook search` | Search people, pages, posts |
+
+## Usage Examples
+
+```bash
+# View a profile
+opencli facebook profile zuck
+
+# Get notifications
+opencli facebook notifications --limit 10
+
+# News feed
+opencli facebook feed --limit 5
+
+# Search
+opencli facebook search "OpenAI" --limit 5
+
+# JSON output
+opencli facebook profile zuck -f json
+```
+
+## Prerequisites
+
+- Chrome running and **logged into** facebook.com
+- [Browser Bridge extension](/guide/browser-bridge) installed

package/docs/adapters/browser/google.md

@@ -0,0 +1,62 @@
+# Google
+
+**Mode**: 🌐 / 🔐 Mixed · **Domains**: `google.com`, `suggestqueries.google.com`, `news.google.com`, `trends.google.com`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli google search <keyword>` | Search Google and extract results from the page |
+| `opencli google suggest <keyword>` | Get Google search suggestions |
+| `opencli google news [keyword]` | Get Google News headlines (top stories or search) |
+| `opencli google trends` | Get Google Trends daily trending searches |
+
+## What works today
+
+- Public API commands work without a browser:
+  - `suggest` — JSON API, no auth needed
+  - `news` — RSS feed, supports top stories and keyword search
+  - `trends` — RSS feed, supports different regions
+- `google search` uses browser mode to extract results from google.com.
+
+## Current limitations
+
+- `google search` may trigger CAPTCHA in Standalone browser mode. Extension mode (with an established Chrome session) is more reliable.
+- Google frequently changes its DOM structure. If `search` stops returning results, selectors may need updating.
+- Snippet extraction may return empty for some results depending on Google's layout.
+
+## Usage Examples
+
+```bash
+# Search Google
+opencli google search "typescript tutorial" --limit 10
+
+# Get search suggestions
+opencli google suggest python
+
+# Get top news headlines
+opencli google news --limit 5
+
+# Search news for a topic
+opencli google news "artificial intelligence" --limit 10 --lang en --region US
+
+# Get trending searches in Japan
+opencli google trends --region JP --limit 10
+
+# Output as JSON
+opencli google search "machine learning" -f json
+```
+
+## Prerequisites
+
+- `suggest`, `news`, `trends` do not require Chrome.
+- `search` requires:
+  - Chrome running (or Standalone mode will auto-launch)
+  - For best results, use the [Browser Bridge extension](/guide/browser-bridge) with an established Google session
+
+## Notes
+
+- `suggest` defaults to `--lang zh-CN`; other commands default to `--lang en`.
+- `news` supports `--lang` and `--region` parameters for localized results.
+- `trends` traffic values are raw strings (e.g. "500K+", "1,000,000+"), not numeric.
+- `search` output includes three result types: `result` (standard), `snippet` (featured answer box), and `paa` (People Also Ask).

package/docs/adapters/browser/grok.md

@@ -0,0 +1,53 @@
+# Grok
+
+**Mode**: Default Grok adapter + optional explicit consumer web path · **Domain**: `grok.com`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli grok ask` | Keep the default Grok ask behavior |
+| `opencli grok ask --web` | Use the explicit grok.com consumer web UI flow |
+
+## Usage Examples
+
+```bash
+# Default / compatibility path
+opencli grok ask --prompt "Explain quantum computing in simple terms"
+
+# Explicit consumer web path
+opencli grok ask --prompt "Explain quantum computing in simple terms" --web
+
+# Best-effort fresh chat on the consumer web path
+opencli grok ask --prompt "Hello" --web --new
+
+# Set custom timeout (default: 120s)
+opencli grok ask --prompt "Write a long essay" --web --timeout 180
+```
+
+### Options
+
+| Option | Description |
+|--------|-------------|
+| `--prompt` | The message to send (required) |
+| `--timeout` | Wait timeout in seconds (default: 120) |
+| `--new` | Start a new chat before sending (default: false) |
+| `--web` | Opt into the explicit grok.com consumer web flow (default: false) |
+
+## Behavior
+
+- `opencli grok ask` keeps the upstream/default behavior intact.
+- `opencli grok ask --web` switches to the newer hardened consumer-web implementation.
+- The `--web` path adds stricter composer detection, clearer blocked/session-gated hints, and waits for a stabilized assistant bubble before returning.
+
+## Prerequisites
+
+- The Grok adapter still depends on browser-backed access to `grok.com`
+- For `--web`, Chrome should already be running with an authenticated Grok consumer session
+- [Browser Bridge extension](/guide/browser-bridge) installed
+
+## Caveats
+
+- `--web` drives the Grok consumer web UI in the browser, not an API.
+- It depends on an already-authenticated session and can fail if Grok shows login, challenge, rate-limit, or other session-gating UI.
+- It may break when the Grok composer DOM, submit button behavior, or message bubble structure changes.

package/docs/adapters/browser/hf.md

@@ -0,0 +1,42 @@
+# Hugging Face
+
+**Mode**: 🌐 Public · **Domain**: `huggingface.co`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli hf top` | Top upvoted Hugging Face papers |
+
+## Usage Examples
+
+```bash
+# Today's top papers
+opencli hf top --limit 10
+
+# All papers (no limit)
+opencli hf top --all
+
+# Specific date
+opencli hf top --date 2025-03-01
+
+# Weekly/monthly top papers
+opencli hf top --period weekly
+opencli hf top --period monthly
+
+# JSON output
+opencli hf top -f json
+```
+
+### Options
+
+| Option | Description |
+|--------|-------------|
+| `--limit` | Number of papers (default: 20) |
+| `--all` | Return all papers, ignoring limit |
+| `--date` | Date in `YYYY-MM-DD` format (defaults to most recent) |
+| `--period` | Time period: `daily`, `weekly`, or `monthly` (default: daily) |
+
+## Prerequisites
+
+- No browser required — uses public Hugging Face API