@jackwener/opencli 1.0.3 → 1.0.4

package/dist/pipeline/steps/download.js

@@ -10,7 +10,7 @@
 import * as fs from 'node:fs';
 import * as path from 'node:path';
 import { render } from '../template.js';
-import { httpDownload, ytdlpDownload, saveDocument, detectContentType, requiresYtdlp, sanitizeFilename, generateFilename, exportCookiesToNetscape, getTempDir, } from '../../download/index.js';
+import { httpDownload, ytdlpDownload, saveDocument, detectContentType, requiresYtdlp, sanitizeFilename, generateFilename, exportCookiesToNetscape, getTempDir, formatCookieHeader, } from '../../download/index.js';
 import { DownloadProgressTracker, formatBytes } from '../../download/progress.js';
 /**
  * Simple async concurrency limiter for downloads.
@@ -33,9 +33,8 @@ async function mapConcurrent(items, limit, fn) {
  */
 async function extractBrowserCookies(page, domain) {
     try {
-        // Use browser evaluate to get document.cookie
-        const cookieString = await page.evaluate(`(() => document.cookie)()`);
-        return typeof cookieString === 'string' ? cookieString : '';
+        const cookies = await page.getCookies(domain ? { domain } : {});
+        return formatCookieHeader(cookies);
     }
     catch {
         return '';
@@ -46,20 +45,17 @@ async function extractBrowserCookies(page, domain) {
  */
 async function extractCookiesArray(page, domain) {
     try {
-        const cookieString = await extractBrowserCookies(page);
-        if (!cookieString)
-            return [];
-        return cookieString.split(';').map((c) => {
-            const [name, ...rest] = c.trim().split('=');
-            return {
-                name: name || '',
-                value: rest.join('=') || '',
-                domain,
-                path: '/',
-                secure: true,
-                httpOnly: false,
-            };
-        }).filter((c) => c.name);
+        const cookies = await page.getCookies({ domain });
+        return cookies
+            .filter((cookie) => cookie.name)
+            .map((cookie) => ({
+            name: cookie.name,
+            value: cookie.value,
+            domain: cookie.domain,
+            path: cookie.path ?? '/',
+            secure: cookie.secure ?? false,
+            httpOnly: cookie.httpOnly ?? false,
+        }));
     }
     catch {
         return [];

package/dist/registry.d.ts

@@ -31,6 +31,7 @@ export interface CliCommand {
     pipeline?: Record<string, unknown>[];
     timeoutSeconds?: number;
     source?: string;
+    footerExtra?: (kwargs: Record<string, any>) => string | undefined;
 }
 /** Internal extension for lazy-loaded TS modules (not exposed in public API) */
 export interface InternalCliCommand extends CliCommand {

package/dist/registry.js

@@ -11,18 +11,21 @@ export var Strategy;
 })(Strategy || (Strategy = {}));
 const _registry = new Map();
 export function cli(opts) {
+    const strategy = opts.strategy ?? (opts.browser === false ? Strategy.PUBLIC : Strategy.COOKIE);
+    const browser = opts.browser ?? (strategy !== Strategy.PUBLIC);
     const cmd = {
         site: opts.site,
         name: opts.name,
         description: opts.description ?? '',
         domain: opts.domain,
-        strategy: opts.strategy ?? (opts.browser === false ? Strategy.PUBLIC : Strategy.COOKIE),
-        browser: opts.browser ?? (opts.strategy === Strategy.PUBLIC ? false : true),
+        strategy,
+        browser,
         args: opts.args ?? [],
         columns: opts.columns,
         func: opts.func,
         pipeline: opts.pipeline,
         timeoutSeconds: opts.timeoutSeconds,
+        footerExtra: opts.footerExtra,
     };
     const key = fullName(cmd);
     _registry.set(key, cmd);

package/dist/runtime.d.ts

@@ -18,7 +18,10 @@ export declare function withTimeoutMs<T>(promise: Promise<T>, timeoutMs: number,
 export interface IBrowserFactory {
     connect(opts?: {
         timeout?: number;
+        workspace?: string;
     }): Promise<IPage>;
     close(): Promise<void>;
 }
-export declare function browserSession<T>(BrowserFactory: new () => IBrowserFactory, fn: (page: IPage) => Promise<T>): Promise<T>;
+export declare function browserSession<T>(BrowserFactory: new () => IBrowserFactory, fn: (page: IPage) => Promise<T>, opts?: {
+    workspace?: string;
+}): Promise<T>;

package/dist/runtime.js

@@ -17,10 +17,10 @@ export function withTimeoutMs(promise, timeoutMs, message) {
         promise.then((value) => { clearTimeout(timer); resolve(value); }, (error) => { clearTimeout(timer); reject(error); });
     });
 }
-export async function browserSession(BrowserFactory, fn) {
+export async function browserSession(BrowserFactory, fn, opts = {}) {
     const mcp = new BrowserFactory();
     try {
-        const page = await mcp.connect({ timeout: DEFAULT_BROWSER_CONNECT_TIMEOUT });
+        const page = await mcp.connect({ timeout: DEFAULT_BROWSER_CONNECT_TIMEOUT, workspace: opts.workspace });
         return await fn(page);
     }
     finally {

package/dist/types.d.ts

@@ -7,6 +7,18 @@
 export interface IPage {
     goto(url: string): 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;

package/dist/verify.d.ts

@@ -15,7 +15,12 @@ export interface VerifyOptions {
 export interface VerifyReport {
     ok: boolean;
     validation: ValidationReport;
-    smoke: null;
+    smoke: null | {
+        requested: boolean;
+        executed: boolean;
+        ok: boolean;
+        summary: string;
+    };
 }
 export declare function verifyClis(opts: VerifyOptions): Promise<VerifyReport>;
 export declare function renderVerifyReport(report: VerifyReport): string;

package/dist/verify.js

@@ -6,10 +6,62 @@
  * to the `opencli test` command or CI pipelines.
  */
 import { validateClisWithTarget, renderValidationReport } from './validate.js';
+import { spawn } from 'node:child_process';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
 export async function verifyClis(opts) {
     const report = validateClisWithTarget([opts.builtinClis, opts.userClis], opts.target);
-    return { ok: report.ok, validation: report, smoke: null };
+    let smoke = null;
+    if (opts.smoke) {
+        smoke = await runSmokeTests(opts.builtinClis);
+    }
+    return { ok: report.ok && (smoke?.ok ?? true), validation: report, smoke };
 }
 export function renderVerifyReport(report) {
-    return renderValidationReport(report.validation);
+    const base = renderValidationReport(report.validation);
+    if (!report.smoke)
+        return base;
+    const status = report.smoke.ok ? 'PASS' : 'FAIL';
+    const mode = report.smoke.executed ? 'executed' : 'skipped';
+    return `${base}\nSmoke: ${status} (${mode}) — ${report.smoke.summary}`;
+}
+async function runSmokeTests(builtinClis) {
+    const projectRoot = path.resolve(builtinClis, '..', '..');
+    const smokeDir = path.join(projectRoot, 'tests', 'smoke');
+    if (!fs.existsSync(smokeDir)) {
+        return {
+            requested: true,
+            executed: false,
+            ok: false,
+            summary: 'Smoke tests are unavailable in this package/environment.',
+        };
+    }
+    const npx = process.platform === 'win32' ? 'npx.cmd' : 'npx';
+    return new Promise((resolve) => {
+        const child = spawn(npx, ['vitest', 'run', 'tests/smoke/', '--reporter=dot'], {
+            cwd: projectRoot,
+            env: { ...process.env },
+            stdio: ['ignore', 'pipe', 'pipe'],
+        });
+        let stderr = '';
+        child.stderr.on('data', (chunk) => {
+            stderr += chunk.toString();
+        });
+        child.on('error', (error) => {
+            resolve({
+                requested: true,
+                executed: false,
+                ok: false,
+                summary: `Failed to start smoke tests: ${error.message}`,
+            });
+        });
+        child.on('close', (code) => {
+            resolve({
+                requested: true,
+                executed: true,
+                ok: code === 0,
+                summary: code === 0 ? 'tests/smoke passed' : (stderr.trim() || `vitest exited with code ${code}`),
+            });
+        });
+    });
 }

package/docs/.vitepress/config.mts

@@ -0,0 +1,193 @@
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  title: 'OpenCLI',
+  description: 'Make any website or Electron App your CLI — AI-powered, account-safe, self-healing.',
+
+  head: [
+    ['meta', { property: 'og:title', content: 'OpenCLI Documentation' }],
+    ['meta', { property: 'og:description', content: 'Make any website or Electron App your CLI.' }],
+    ['meta', { name: 'twitter:card', content: 'summary_large_image' }],
+  ],
+
+  locales: {
+    root: {
+      label: 'English',
+      lang: 'en',
+      themeConfig: {
+        nav: [
+          { text: 'Guide', link: '/guide/getting-started' },
+          { text: 'Adapters', link: '/adapters/' },
+          { text: 'Developer', link: '/developer/contributing' },
+          { text: 'Advanced', link: '/advanced/cdp' },
+        ],
+        sidebar: {
+          '/guide/': [
+            {
+              text: 'Guide',
+              items: [
+                { text: 'Getting Started', link: '/guide/getting-started' },
+                { text: 'Installation', link: '/guide/installation' },
+                { text: 'Browser Bridge', link: '/guide/browser-bridge' },
+                { text: 'Troubleshooting', link: '/guide/troubleshooting' },
+              ],
+            },
+          ],
+          '/adapters/': [
+            {
+              text: 'Adapters Overview',
+              items: [
+                { text: 'All Adapters', link: '/adapters/' },
+              ],
+            },
+            {
+              text: 'Browser Adapters',
+              collapsed: false,
+              items: [
+                { text: 'Twitter / X', link: '/adapters/browser/twitter' },
+                { text: 'Reddit', link: '/adapters/browser/reddit' },
+                { text: 'Bilibili', link: '/adapters/browser/bilibili' },
+                { text: 'Zhihu', link: '/adapters/browser/zhihu' },
+                { text: 'Xiaohongshu', link: '/adapters/browser/xiaohongshu' },
+                { text: 'Weibo', link: '/adapters/browser/weibo' },
+                { text: 'YouTube', link: '/adapters/browser/youtube' },
+                { text: 'Xueqiu', link: '/adapters/browser/xueqiu' },
+                { text: 'V2EX', link: '/adapters/browser/v2ex' },
+                { 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: 'Public API Adapters',
+              collapsed: false,
+              items: [
+                { text: 'HackerNews', link: '/adapters/browser/hackernews' },
+                { text: 'GitHub', link: '/adapters/browser/github' },
+                { 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: 'Desktop Adapters',
+              collapsed: false,
+              items: [
+                { text: 'Cursor', link: '/adapters/desktop/cursor' },
+                { text: 'Codex', link: '/adapters/desktop/codex' },
+                { text: 'Antigravity', link: '/adapters/desktop/antigravity' },
+                { text: 'ChatGPT', link: '/adapters/desktop/chatgpt' },
+                { 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' },
+              ],
+            },
+          ],
+          '/developer/': [
+            {
+              text: 'Developer Guide',
+              items: [
+                { text: 'Contributing', link: '/developer/contributing' },
+                { text: 'Testing', link: '/developer/testing' },
+                { text: 'Architecture', link: '/developer/architecture' },
+                { text: 'YAML Adapter Guide', link: '/developer/yaml-adapter' },
+                { text: 'TypeScript Adapter Guide', link: '/developer/ts-adapter' },
+                { text: 'AI Workflow', link: '/developer/ai-workflow' },
+              ],
+            },
+          ],
+          '/advanced/': [
+            {
+              text: 'Advanced',
+              items: [
+                { text: 'Chrome DevTools Protocol', link: '/advanced/cdp' },
+                { text: 'Electron Apps', link: '/advanced/electron' },
+                { text: 'Remote Chrome', link: '/advanced/remote-chrome' },
+                { text: 'Download Support', link: '/advanced/download' },
+              ],
+            },
+          ],
+        },
+      },
+    },
+    zh: {
+      label: '中文',
+      lang: 'zh-CN',
+      link: '/zh/',
+      themeConfig: {
+        nav: [
+          { text: '指南', link: '/zh/guide/getting-started' },
+          { text: '适配器', link: '/zh/adapters/' },
+          { text: '开发者', link: '/zh/developer/contributing' },
+          { text: '进阶', link: '/zh/advanced/cdp' },
+        ],
+        sidebar: {
+          '/zh/guide/': [
+            {
+              text: '指南',
+              items: [
+                { text: '快速开始', link: '/zh/guide/getting-started' },
+                { text: '安装', link: '/zh/guide/installation' },
+                { text: 'Browser Bridge', link: '/zh/guide/browser-bridge' },
+                { text: '问题排查', link: '/zh/guide/troubleshooting' },
+              ],
+            },
+          ],
+          '/zh/adapters/': [
+            {
+              text: '适配器概览',
+              items: [
+                { text: '所有适配器', link: '/zh/adapters/' },
+              ],
+            },
+          ],
+          '/zh/developer/': [
+            {
+              text: '开发者指南',
+              items: [
+                { text: '贡献指南', link: '/zh/developer/contributing' },
+                { text: '测试', link: '/zh/developer/testing' },
+              ],
+            },
+          ],
+          '/zh/advanced/': [
+            {
+              text: '进阶',
+              items: [
+                { text: 'Chrome DevTools Protocol', link: '/zh/advanced/cdp' },
+              ],
+            },
+          ],
+        },
+      },
+    },
+  },
+
+  themeConfig: {
+    search: {
+      provider: 'local',
+    },
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/jackwener/opencli' },
+      { icon: 'npm', link: 'https://www.npmjs.com/package/@jackwener/opencli' },
+    ],
+
+    editLink: {
+      pattern: 'https://github.com/jackwener/opencli/edit/main/docs/:path',
+      text: 'Edit this page on GitHub',
+    },
+
+    footer: {
+      message: 'Released under the Apache-2.0 License.',
+      copyright: 'Copyright © 2024-present jackwener',
+    },
+  },
+})

package/docs/adapters/browser/apple-podcasts.md

@@ -0,0 +1,28 @@
+# Apple Podcasts
+
+**Mode**: 🌐 Public · **Domain**: `podcasts.apple.com`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli apple-podcasts search` | |
+| `opencli apple-podcasts episodes` | |
+| `opencli apple-podcasts top` | |
+
+## Usage Examples
+
+```bash
+# Quick start
+opencli apple-podcasts search --limit 5
+
+# JSON output
+opencli apple-podcasts search -f json
+
+# Verbose mode
+opencli apple-podcasts search -v
+```
+
+## Prerequisites
+
+- No browser required — uses public API

package/docs/adapters/browser/bbc.md

@@ -0,0 +1,26 @@
+# BBC News
+
+**Mode**: 🌐 Public · **Domain**: `bbc.com`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli bbc news` | |
+
+## Usage Examples
+
+```bash
+# Quick start
+opencli bbc news --limit 5
+
+# JSON output
+opencli bbc news -f json
+
+# Verbose mode
+opencli bbc news -v
+```
+
+## Prerequisites
+
+- No browser required — uses public API

package/docs/adapters/browser/bilibili.md

@@ -0,0 +1,38 @@
+# Bilibili
+
+**Mode**: 🔐 Browser · **Domain**: `bilibili.com`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli bilibili hot` | |
+| `opencli bilibili search` | |
+| `opencli bilibili me` | |
+| `opencli bilibili favorite` | |
+| `opencli bilibili history` | |
+| `opencli bilibili feed` | |
+| `opencli bilibili subtitle` | |
+| `opencli bilibili dynamic` | |
+| `opencli bilibili ranking` | |
+| `opencli bilibili following` | |
+| `opencli bilibili user-videos` | |
+| `opencli bilibili download` | |
+
+## Usage Examples
+
+```bash
+# Quick start
+opencli bilibili hot --limit 5
+
+# JSON output
+opencli bilibili hot -f json
+
+# Verbose mode
+opencli bilibili hot -v
+```
+
+## Prerequisites
+
+- Chrome running and **logged into** bilibili.com
+- [Browser Bridge extension](/guide/browser-bridge) installed

package/docs/adapters/browser/boss.md

@@ -0,0 +1,28 @@
+# BOSS Zhipin
+
+**Mode**: 🔐 Browser · **Domain**: `zhipin.com`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli boss search` | |
+| `opencli boss detail` | |
+
+## Usage Examples
+
+```bash
+# Quick start
+opencli boss search --limit 5
+
+# JSON output
+opencli boss search -f json
+
+# Verbose mode
+opencli boss search -v
+```
+
+## Prerequisites
+
+- Chrome running and **logged into** zhipin.com
+- [Browser Bridge extension](/guide/browser-bridge) installed

package/docs/adapters/browser/coupang.md

@@ -0,0 +1,28 @@
+# Coupang
+
+**Mode**: 🔐 Browser · **Domain**: `coupang.com`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli coupang search` | |
+| `opencli coupang add-to-cart` | |
+
+## Usage Examples
+
+```bash
+# Quick start
+opencli coupang search --limit 5
+
+# JSON output
+opencli coupang search -f json
+
+# Verbose mode
+opencli coupang search -v
+```
+
+## Prerequisites
+
+- Chrome running and **logged into** coupang.com
+- [Browser Bridge extension](/guide/browser-bridge) installed

package/docs/adapters/browser/ctrip.md

@@ -0,0 +1,27 @@
+# Ctrip (携程)
+
+**Mode**: 🔐 Browser · **Domain**: `ctrip.com`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli ctrip search` | |
+
+## Usage Examples
+
+```bash
+# Quick start
+opencli ctrip search --limit 5
+
+# JSON output
+opencli ctrip search -f json
+
+# Verbose mode
+opencli ctrip search -v
+```
+
+## Prerequisites
+
+- Chrome running and **logged into** ctrip.com
+- [Browser Bridge extension](/guide/browser-bridge) installed

package/docs/adapters/browser/github.md

@@ -0,0 +1,26 @@
+# GitHub
+
+**Mode**: 🌐 Public · **Domain**: `github.com`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli github search` | |
+
+## Usage Examples
+
+```bash
+# Quick start
+opencli github search --limit 5
+
+# JSON output
+opencli github search -f json
+
+# Verbose mode
+opencli github search -v
+```
+
+## Prerequisites
+
+- No browser required — uses public API

package/docs/adapters/browser/hackernews.md

@@ -0,0 +1,26 @@
+# HackerNews
+
+**Mode**: 🌐 Public · **Domain**: `news.ycombinator.com`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli hackernews top` | |
+
+## Usage Examples
+
+```bash
+# Quick start
+opencli hackernews top --limit 5
+
+# JSON output
+opencli hackernews top -f json
+
+# Verbose mode
+opencli hackernews top -v
+```
+
+## Prerequisites
+
+- No browser required — uses public API

package/docs/adapters/browser/linkedin.md

@@ -0,0 +1,27 @@
+# LinkedIn
+
+**Mode**: 🔐 Browser · **Domain**: `linkedin.com`
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `opencli linkedin search` | |
+
+## Usage Examples
+
+```bash
+# Quick start
+opencli linkedin search --limit 5
+
+# JSON output
+opencli linkedin search -f json
+
+# Verbose mode
+opencli linkedin search -v
+```
+
+## Prerequisites
+
+- Chrome running and **logged into** linkedin.com
+- [Browser Bridge extension](/guide/browser-bridge) installed