@jackwener/opencli 1.6.1 → 1.6.3

package/CLI-ONESHOT.md

@@ -1,216 +0,0 @@
-# CLI-ONESHOT — 单点快速 CLI 生成
-
-> 给一个 URL + 一句话描述，4 步生成一个 CLI 命令。
-> 完整探索式开发请看 [CLI-EXPLORER.md](./CLI-EXPLORER.md)。
-
----
-
-## 输入
-
-| 项目 | 示例 |
-|------|------|
-| **URL** | `https://x.com/jakevin7/lists` |
-| **Goal** | 获取我的 Twitter Lists |
-
----
-
-## 流程
-
-### Step 1: 打开页面 + 抓包
-
-```
-1. browser_navigate → 打开目标 URL
-2. 等待 3-5 秒（让页面加载完、API 请求触发）
-3. browser_network_requests → 筛选 JSON API
-```
-
-**关键**：只关注返回 `application/json` 的请求，忽略静态资源。
-如果没有自动触发 API，手动点击目标按钮/标签再抓一次。
-
-### Step 2: 锁定一个接口
-
-从抓包结果中找到**那个**目标 API。看这几个字段：
-
-| 字段 | 关注什么 |
-|------|----------|
-| URL | API 路径 pattern（如 `/i/api/graphql/xxx/ListsManagePinTimeline`） |
-| Method | GET / POST |
-| Headers | 有 Cookie? Bearer? CSRF? 自定义签名? |
-| Response | 数据在哪个路径（如 `data.list.lists`） |
-
-### Step 3: 验证接口能复现
-
-在 `browser_evaluate` 中用 `fetch` 复现请求：
-
-```javascript
-// Tier 2 (Cookie): 大多数情况
-fetch('/api/endpoint', { credentials: 'include' }).then(r => r.json())
-
-// Tier 3 (Header): 如 Twitter 需要额外 header
-const ct0 = document.cookie.match(/ct0=([^;]+)/)?.[1];
-fetch('/api/endpoint', {
-  headers: { 'Authorization': 'Bearer ...', 'X-Csrf-Token': ct0 },
-  credentials: 'include'
-}).then(r => r.json())
-```
-
-如果 fetch 能拿到数据 → 用 YAML 或简单 TS adapter。
-如果 fetch 拿不到（签名/风控）→ 用 intercept 策略。
-
-### Step 4: 套模板，生成 adapter
-
-根据 Step 3 判定的策略，选一个模板生成文件。
-
----
-
-## 认证速查
-
-```
-fetch(url) 直接能拿到？              → Tier 1: public   (YAML, browser: false)
-fetch(url, {credentials:'include'})？ → Tier 2: cookie   (YAML)
-加 Bearer/CSRF header 后拿到？        → Tier 3: header   (TS)
-都不行，但页面自己能请求成功？          → Tier 4: intercept (TS, installInterceptor)
-```
-
----
-
-## 模板
-
-### YAML — Cookie/Public（最简）
-
-```yaml
-# src/clis/<site>/<name>.yaml
-site: mysite
-name: mycommand
-description: "一句话描述"
-domain: www.example.com
-strategy: cookie          # 或 public (加 browser: false)
-
-args:
-  limit:
-    type: int
-    default: 20
-
-pipeline:
-  - navigate: https://www.example.com/target-page
-
-  - evaluate: |
-      (async () => {
-        const res = await fetch('/api/target', { credentials: 'include' });
-        const d = await res.json();
-        return (d.data?.items || []).map(item => ({
-          title: item.title,
-          value: item.value,
-        }));
-      })()
-
-  - map:
-      rank: ${{ index + 1 }}
-      title: ${{ item.title }}
-      value: ${{ item.value }}
-
-  - limit: ${{ args.limit }}
-
-columns: [rank, title, value]
-```
-
-### TS — Intercept（抓包模式）
-
-```typescript
-// src/clis/<site>/<name>.ts
-import { cli, Strategy } from '../../registry.js';
-
-cli({
-  site: 'mysite',
-  name: 'mycommand',
-  description: '一句话描述',
-  domain: 'www.example.com',
-  strategy: Strategy.INTERCEPT,
-  browser: true,
-  args: [
-    { name: 'limit', type: 'int', default: 20 },
-  ],
-  columns: ['rank', 'title', 'value'],
-  func: async (page, kwargs) => {
-    // 1. 导航
-    await page.goto('https://www.example.com/target-page');
-    await page.wait(3);
-
-    // 2. 注入拦截器（URL 子串匹配）
-    await page.installInterceptor('target-api-keyword');
-
-    // 3. 触发 API（滚动/点击）
-    await page.autoScroll({ times: 2, delayMs: 2000 });
-
-    // 4. 读取拦截的响应
-    const requests = await page.getInterceptedRequests();
-    if (!requests?.length) return [];
-
-    let results: any[] = [];
-    for (const req of requests) {
-      const items = req.data?.data?.items || [];
-      results.push(...items);
-    }
-
-    return results.slice(0, kwargs.limit).map((item, i) => ({
-      rank: i + 1,
-      title: item.title || '',
-      value: item.value || '',
-    }));
-  },
-});
-```
-
-### TS — Header（如 Twitter GraphQL）
-
-```typescript
-import { cli, Strategy } from '../../registry.js';
-
-cli({
-  site: 'twitter',
-  name: 'mycommand',
-  description: '一句话描述',
-  domain: 'x.com',
-  strategy: Strategy.HEADER,
-  browser: true,
-  args: [
-    { name: 'limit', type: 'int', default: 20 },
-  ],
-  columns: ['rank', 'name', 'value'],
-  func: async (page, kwargs) => {
-    await page.goto('https://x.com');
-    const data = await page.evaluate(`(async () => {
-      const ct0 = document.cookie.match(/ct0=([^;]+)/)?.[1];
-      if (!ct0) return { error: 'Not logged in' };
-      const bearer = 'AAAAAAAAAAAAAAAAAAAAANRILgAAAAAAnNwIzUejRCOuH5E6I8xnZz4puTs%3D...';
-      const res = await fetch('/i/api/graphql/QUERY_ID/Endpoint', {
-        headers: {
-          'Authorization': 'Bearer ' + decodeURIComponent(bearer),
-          'X-Csrf-Token': ct0,
-          'X-Twitter-Auth-Type': 'OAuth2Session',
-        },
-        credentials: 'include',
-      });
-      return res.json();
-    })()`);
-    // 解析 data...
-    return [];
-  },
-});
-```
-
----
-
-## 测试（必做）
-
-```bash
-npm run build                              # 语法检查
-opencli list | grep mysite                 # 确认注册
-opencli mysite mycommand --limit 3 -v      # 实际运行
-```
-
----
-
-## 就这样，没了
-
-写完文件 → build → run → 提交。有问题再看 [CLI-EXPLORER.md](./CLI-EXPLORER.md)。

package/CONTRIBUTING.md

@@ -1,208 +0,0 @@
-# Contributing to OpenCLI
-
-Thanks for your interest in contributing to OpenCLI.
-
-## Quick Start
-
-```bash
-# 1. Fork & clone
-git clone git@github.com:<your-username>/opencli.git
-cd opencli
-
-# 2. Install dependencies
-npm install
-
-# 3. Build
-npm run build
-
-# 4. Run a few checks
-npx tsc --noEmit
-npm test
-npm run test:adapter
-
-# 5. Link globally (optional, for testing `opencli` command)
-npm link
-```
-
-## Adding a New Site Adapter
-
-This is the most common type of contribution. Start with YAML when possible, and use TypeScript only when you need browser-side logic or multi-step flows.
-
-### YAML Adapter (Recommended for data-fetching commands)
-
-Create a file like `src/clis/<site>/<command>.yaml`:
-
-```yaml
-site: mysite
-name: trending
-description: Trending posts on MySite
-domain: www.mysite.com
-strategy: public      # public | cookie | header
-browser: false        # true if browser session is needed
-
-args:
-  query:
-    positional: true
-    type: str
-    required: true
-    description: Search keyword
-  limit:
-    type: int
-    default: 20
-    description: Number of items
-
-pipeline:
-  - fetch:
-      url: https://api.mysite.com/trending
-
-  - map:
-      rank: ${{ index + 1 }}
-      title: ${{ item.title }}
-      score: ${{ item.score }}
-      url: ${{ item.url }}
-
-  - limit: ${{ args.limit }}
-
-columns: [rank, title, score, url]
-```
-
-See [`hackernews/top.yaml`](src/clis/hackernews/top.yaml) for a real example.
-
-### TypeScript Adapter (For complex browser interactions)
-
-Create a file like `src/clis/<site>/<command>.ts`:
-
-```typescript
-import { cli, Strategy } from '../../registry.js';
-
-cli({
-  site: 'mysite',
-  name: 'search',
-  description: 'Search MySite',
-  domain: 'www.mysite.com',
-  strategy: Strategy.COOKIE,
-  args: [
-    { name: 'query', positional: true, required: true, help: 'Search query' },
-    { name: 'limit', type: 'int', default: 10, help: 'Max results' },
-  ],
-  columns: ['title', 'url', 'date'],
-
-  func: async (page, kwargs) => {
-    const { query, limit = 10 } = kwargs;
-    await page.goto('https://www.mysite.com');
-
-    const data = await page.evaluate(`
-      (async () => {
-        const res = await fetch('/api/search?q=${encodeURIComponent(query)}', {
-          credentials: 'include'
-        });
-        return (await res.json()).results;
-      })()
-    `);
-
-    return data.slice(0, Number(limit)).map((item: any) => ({
-      title: item.title,
-      url: item.url,
-      date: item.created_at,
-    }));
-  },
-});
-```
-
-Use `opencli explore <url>` to discover APIs and see [CLI-EXPLORER.md](./CLI-EXPLORER.md) if you need the full adapter workflow.
-
-### Validate Your Adapter
-
-```bash
-# Validate YAML syntax and schema
-opencli validate
-
-# Test your command
-opencli <site> <command> --limit 3 -f json
-
-# Verbose mode for debugging
-opencli <site> <command> -v
-```
-
-## Arg Design Convention
-
-Use **positional** for the primary, required argument of a command (the "what" — query, symbol, id, url, username). Use **named options** (`--flag`) for secondary/optional configuration (limit, format, sort, page, filters, language, date).
-
-**Rule of thumb**: Think about how the user will type the command. `opencli xueqiu stock SH600519` is more natural than `opencli xueqiu stock --symbol SH600519`.
-
-| Arg type | Positional? | Examples |
-|----------|-------------|----------|
-| Main target (query, symbol, id, url, username) | ✅ `positional: true` | `search '茅台'`, `stock SH600519`, `download BV1xxx` |
-| Configuration (limit, format, sort, page, type, filters) | ❌ Named `--flag` | `--limit 10`, `--format json`, `--sort hot`, `--location seattle` |
-
-Do **not** convert an argument to positional just because it appears first in the file. If the argument is optional, acts like a filter, or selects a mode/configuration, it should usually stay a named option.
-
-YAML example:
-```yaml
-args:
-  query:
-    positional: true     # ← primary arg, user types it directly
-    type: str
-    required: true
-  limit:
-    type: int            # ← config arg, user types --limit 10
-    default: 20
-```
-
-TS example:
-```typescript
-args: [
-  { name: 'query', positional: true, required: true, help: 'Search query' },
-  { name: 'limit', type: 'int', default: 10, help: 'Max results' },
-]
-```
-
-## Testing
-
-See [TESTING.md](./TESTING.md) for the full guide and exact test locations.
-
-```bash
-npm test                      # Core unit tests (non-adapter)
-npm run test:adapter         # Focused adapter tests: zhihu/twitter/reddit/bilibili
-npx vitest run tests/e2e/     # E2E tests
-npx vitest run                # All tests
-```
-
-## Code Style
-
-- **TypeScript strict mode** — avoid `any` where possible.
-- **ES Modules** — use `.js` extensions in imports (TypeScript output).
-- **Naming**: `kebab-case` for files, `camelCase` for variables/functions, `PascalCase` for types/classes.
-- **No default exports** — use named exports.
-
-## Commit Convention
-
-We use [Conventional Commits](https://www.conventionalcommits.org/):
-
-```
-feat(twitter): add thread command
-fix(browser): handle CDP timeout gracefully
-docs: update CONTRIBUTING.md
-test(reddit): add e2e test for save command
-chore: bump vitest to v4
-```
-
-Common scopes: site name (`twitter`, `reddit`) or module name (`browser`, `pipeline`, `engine`).
-
-## Submitting a Pull Request
-
-1. Create a feature branch: `git checkout -b feat/mysite-trending`
-2. Make your changes and add tests when relevant
-3. Run the checks that apply:
-   ```bash
-   npx tsc --noEmit           # Type check
-   npm test                   # Core unit tests
-   npm run test:adapter       # Focused adapter tests (if you touched adapter logic)
-   opencli validate           # YAML validation (if applicable)
-   ```
-4. Commit using conventional commit format
-5. Push and open a PR
-
-## License
-
-By contributing, you agree that your contributions will be licensed under the [Apache-2.0 License](./LICENSE).

package/PRIVACY.md

@@ -1,57 +0,0 @@
-# Privacy Policy — OpenCLI Browser Extension
-
-**Last updated**: 2026-03-25
-
-## What the extension does
-
-The OpenCLI Browser Extension is a bridge between the [OpenCLI](https://github.com/jackwener/opencli) command-line tool and your Chrome browser. It receives commands from a **locally running daemon** process via WebSocket (`localhost` only) and executes them in **isolated Chrome windows** that are separate from your normal browsing session.
-
-## Data collection
-
-The extension does **NOT** collect, store, transmit, or sell any personal data. Specifically:
-
-- **No analytics or telemetry** — no data is sent to any remote server.
-- **No user tracking** — no cookies, identifiers, or fingerprints are created.
-- **No external network requests** — all communication is strictly `localhost` (WebSocket to `ws://localhost:19825`).
-
-## Permissions explained
-
-| Permission | Why it's needed |
-|------------|----------------|
-| `debugger` | Required to use Chrome DevTools Protocol (CDP) for browser automation — executing JavaScript, capturing page content, and taking screenshots in isolated windows. |
-| `tabs` | Required to create and manage isolated automation windows and tabs, separate from the user's browsing session. |
-| `cookies` | Required to read site-specific cookies (scoped by domain) so CLI commands can authenticate with websites the user is already logged into. Cookies are **never written, modified, or transmitted externally**. |
-| `activeTab` | Required to identify the currently active tab for context-aware commands. |
-| `alarms` | Required to maintain the WebSocket connection to the local daemon via periodic keepalive checks. |
-
-## Data flow
-
-```
-User's terminal (opencli CLI)
-    ↓ (spawns)
-Local daemon process (localhost:19825)
-    ↓ (WebSocket, localhost only)
-Chrome Extension (this extension)
-    ↓ (Chrome APIs)
-Isolated Chrome automation window
-```
-
-All data stays on the user's machine. No data leaves `localhost`.
-
-## Cookie access
-
-The extension reads cookies **only** when explicitly requested by a CLI command, and **only** for the specific domain the command targets. It cannot and does not dump all cookies. Cookie data is returned to the local daemon process and is never sent to any external server.
-
-## Third-party services
-
-This extension does not integrate with, send data to, or receive data from any third-party service.
-
-## Open source
-
-This extension is fully open source. You can audit the complete source code at:
-https://github.com/jackwener/opencli/tree/main/extension
-
-## Contact
-
-For privacy questions or concerns, please open an issue at:
-https://github.com/jackwener/opencli/issues

package/SKILL.md

@@ -1,59 +0,0 @@
----
-name: opencli
-description: "OpenCLI — Make any website or Electron App your CLI. Zero risk, AI-powered, reuse Chrome login."
-version: 1.5.6
-author: jackwener
-tags: [cli, browser, web, chrome-extension, cdp, AI, agent, operate]
----
-
-# OpenCLI
-
-> Make any website or Electron App your CLI. Reuse Chrome login, zero risk, AI-powered.
-
-## Skills
-
-OpenCLI has three specialized skills. Use the one that matches your task:
-
-### 1. CLI Commands (`skills/cli/SKILL.md`)
-Use existing CLI commands to fetch data, interact with websites and desktop apps.
-```bash
-opencli twitter trending --limit 10
-opencli hackernews top --limit 5
-opencli bilibili hot
-```
-
-### 2. Browser Automation (`skills/opencli-operate/SKILL.md`)
-Make websites accessible for AI agents. Navigate, click, type, extract, wait — with existing Chrome login sessions. No LLM API key needed.
-```bash
-opencli operate open https://example.com
-opencli operate state                    # See interactive elements with [N] indices
-opencli operate click 3                  # Click element [3]
-opencli operate network                  # Discover APIs
-opencli operate init site/cmd            # Generate adapter scaffold
-opencli operate verify site/cmd          # Test the adapter
-```
-
-### 3. Adapter Development (`skills/adapter-dev/SKILL.md`)
-Create new CLI commands from websites. Explore APIs, record traffic, write TypeScript adapters.
-```bash
-opencli explore https://example.com
-opencli record https://example.com
-opencli generate https://example.com --goal "hot"
-```
-
-## Quick Setup
-
-```bash
-npm install -g @jackwener/opencli
-opencli doctor    # Verify Chrome extension + daemon
-```
-
-## Configuration
-
-```bash
-# For AI agent (opencli operate)
-export OPENCLI_PROVIDER=anthropic       # or openai
-export OPENCLI_MODEL=sonnet             # model alias
-export OPENCLI_API_KEY=sk-ant-...       # API key
-export OPENCLI_BASE_URL=https://...     # optional proxy
-```