@huyuan-ai/cli 1.3.0 → 1.3.1

package/UPGRADE.md

@@ -2,6 +2,12 @@
 
 本文档说明各版本相对上一版本的重要变更，以及从旧版升级时的注意点。
 
+## 1.3.1
+
+### 修复
+
+- **全局安装后 `huyuan-opencli` 首次运行**：补齐随包发布的 `vendor/opencli/scripts/` 与 `vendor/opencli/package.json`，使 OpenCLI 首次运行时的 `fetch-adapters` 能正确解析路径并读取版本（不再出现 `Cannot find module .../fetch-adapters.js`）。
+
 ## 1.3.0
 
 ### 新增

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@huyuan-ai/cli",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "publishConfig": {
     "access": "public"
   },
@@ -29,6 +29,8 @@
   "files": [
     "dist",
     "vendor/opencli/dist",
+    "vendor/opencli/package.json",
+    "vendor/opencli/scripts",
     "README.md",
     "UPGRADE.md"
   ],

package/vendor/opencli/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "@jackwener/opencli",
+  "version": "1.6.7",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Make any website or Electron App your CLI. AI-powered.",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "type": "module",
+  "main": "dist/src/main.js",
+  "bin": {
+    "opencli": "dist/src/main.js"
+  },
+  "exports": {
+    ".": "./dist/src/main.js",
+    "./registry": "./dist/src/registry-api.js",
+    "./errors": "./dist/src/errors.js",
+    "./types": "./dist/src/types.js",
+    "./utils": "./dist/src/utils.js",
+    "./logger": "./dist/src/logger.js",
+    "./launcher": "./dist/src/launcher.js",
+    "./browser/cdp": "./dist/src/browser/cdp.js",
+    "./browser/page": "./dist/src/browser/page.js",
+    "./browser/utils": "./dist/src/browser/utils.js",
+    "./download": "./dist/src/download/index.js",
+    "./download/article-download": "./dist/src/download/article-download.js",
+    "./download/media-download": "./dist/src/download/media-download.js",
+    "./download/progress": "./dist/src/download/progress.js",
+    "./pipeline": "./dist/src/pipeline/index.js"
+  },
+  "files": [
+    "dist/src/",
+    "dist/clis/",
+    "dist/cli-manifest.json",
+    "scripts/",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "dev": "tsx src/main.ts",
+    "dev:bun": "bun src/main.ts",
+    "build": "npm run clean-dist && tsc && npm run clean-yaml && npm run copy-yaml && npm run build-manifest",
+    "build-manifest": "node dist/src/build-manifest.js",
+    "clean-dist": "node scripts/clean-dist.cjs",
+    "clean-yaml": "node scripts/clean-yaml.cjs",
+    "copy-yaml": "node scripts/copy-yaml.cjs",
+    "start": "node dist/src/main.js",
+    "start:bun": "bun dist/src/main.js",
+    "postinstall": "node scripts/postinstall.js || true; node scripts/fetch-adapters.js || true",
+    "typecheck": "tsc --noEmit",
+    "lint": "tsc --noEmit",
+    "prepare": "[ -d src ] && npm run build || true",
+    "prepublishOnly": "npm run build",
+    "test": "vitest run --project unit",
+    "test:bun": "bun vitest run --project unit",
+    "test:adapter": "vitest run --project adapter",
+    "test:all": "vitest run",
+    "test:e2e": "vitest run --project e2e",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
+  },
+  "keywords": [
+    "cli",
+    "browser",
+    "web",
+    "ai"
+  ],
+  "author": "jackwener",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jackwener/opencli.git"
+  },
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "cli-table3": "^0.6.5",
+    "commander": "^14.0.3",
+    "js-yaml": "^4.1.0",
+    "turndown": "^7.2.2",
+    "undici": "^7.24.6",
+    "ws": "^8.18.0"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^22.13.10",
+    "@types/turndown": "^5.0.6",
+    "@types/ws": "^8.5.13",
+    "tsx": "^4.19.3",
+    "typescript": "^6.0.2",
+    "vitepress": "^1.6.4",
+    "vitest": "^4.1.0"
+  }
+}

package/vendor/opencli/scripts/check-doc-coverage.sh

@@ -0,0 +1,71 @@
+#!/usr/bin/env bash
+# check-doc-coverage.sh — Verify every adapter in clis/ has a doc page.
+#
+# Exit codes:
+#   0 — all adapters have docs
+#   1 — at least one adapter is missing documentation
+#
+# Usage:
+#   bash scripts/check-doc-coverage.sh          # report only
+#   bash scripts/check-doc-coverage.sh --strict  # exit 1 on missing docs
+
+set -euo pipefail
+
+STRICT=false
+if [[ "${1:-}" == "--strict" ]]; then
+  STRICT=true
+fi
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+ROOT_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"
+
+SRC_DIR="$ROOT_DIR/clis"
+DOCS_DIR="$ROOT_DIR/docs/adapters"
+
+missing=()
+covered=0
+total=0
+
+for adapter_dir in "$SRC_DIR"/*/; do
+  adapter_name="$(basename "$adapter_dir")"
+  # Skip internal directories (e.g., _shared)
+  [[ "$adapter_name" == _* ]] && continue
+  total=$((total + 1))
+
+  # Check if doc exists in browser/ or desktop/ subdirectories
+  if [[ -f "$DOCS_DIR/browser/$adapter_name.md" ]] || \
+     [[ -f "$DOCS_DIR/desktop/$adapter_name.md" ]]; then
+    covered=$((covered + 1))
+  else
+    # Handle directory name mismatches (e.g., discord-app -> discord)
+    alt_name="${adapter_name%-app}"
+    if [[ "$alt_name" != "$adapter_name" ]] && \
+       { [[ -f "$DOCS_DIR/browser/$alt_name.md" ]] || \
+         [[ -f "$DOCS_DIR/desktop/$alt_name.md" ]]; }; then
+      covered=$((covered + 1))
+    else
+      missing+=("$adapter_name")
+    fi
+  fi
+done
+
+echo "📊 Doc Coverage: $covered/$total adapters documented"
+echo ""
+
+if [[ ${#missing[@]} -gt 0 ]]; then
+  echo "⚠️  Missing docs for ${#missing[@]} adapter(s):"
+  for name in "${missing[@]}"; do
+    echo "   - $name  →  create docs/adapters/browser/$name.md or docs/adapters/desktop/$name.md"
+  done
+  echo ""
+  if $STRICT; then
+    echo "❌ Doc check failed (--strict mode)."
+    exit 1
+  else
+    echo "💡 Run with --strict to fail CI on missing docs."
+    exit 0
+  fi
+else
+  echo "✅ All adapters have documentation."
+  exit 0
+fi

package/vendor/opencli/scripts/clean-dist.cjs

@@ -0,0 +1,13 @@
+/**
+ * Remove dist/ before a fresh build so deleted adapters do not leave stale
+ * compiled files behind in dist/clis/.
+ */
+const { existsSync, rmSync } = require('fs');
+
+if (existsSync('dist')) {
+  rmSync('dist', { recursive: true, force: true });
+}
+
+if (existsSync('tsconfig.tsbuildinfo')) {
+  rmSync('tsconfig.tsbuildinfo', { force: true });
+}

package/vendor/opencli/scripts/clean-yaml.cjs

@@ -0,0 +1,19 @@
+/**
+ * Clean YAML files from dist/clis/ before copying fresh ones.
+ */
+const { readdirSync, rmSync, existsSync, statSync } = require('fs');
+const path = require('path');
+
+function walk(dir) {
+  if (!existsSync(dir)) return;
+  for (const f of readdirSync(dir)) {
+    const fp = path.join(dir, f);
+    if (statSync(fp).isDirectory()) {
+      walk(fp);
+    } else if (/\.ya?ml$/.test(f)) {
+      rmSync(fp);
+    }
+  }
+}
+
+walk('dist/clis');

package/vendor/opencli/scripts/copy-yaml.cjs

@@ -0,0 +1,28 @@
+/**
+ * Copy YAML files from clis/ to dist/clis/.
+ */
+const { readdirSync, copyFileSync, mkdirSync, existsSync, statSync } = require('fs');
+const path = require('path');
+
+function walk(src, dst) {
+  if (!existsSync(src)) return;
+  for (const f of readdirSync(src)) {
+    const sp = path.join(src, f);
+    const dp = path.join(dst, f);
+    if (statSync(sp).isDirectory()) {
+      walk(sp, dp);
+    } else if (/\.ya?ml$/.test(f)) {
+      mkdirSync(path.dirname(dp), { recursive: true });
+      copyFileSync(sp, dp);
+    }
+  }
+}
+
+walk('clis', 'dist/clis');
+
+// Copy external CLI registry to dist/
+const extSrc = 'src/external-clis.yaml';
+if (existsSync(extSrc)) {
+  mkdirSync('dist/src', { recursive: true });
+  copyFileSync(extSrc, 'dist/src/external-clis.yaml');
+}

package/vendor/opencli/scripts/fetch-adapters.js

@@ -0,0 +1,157 @@
+#!/usr/bin/env node
+
+/**
+ * Copy official CLI adapters from the installed package to ~/.opencli/clis/.
+ *
+ * Update strategy (file-level granularity via adapter-manifest.json):
+ * - Official files (in new manifest) are unconditionally overwritten
+ * - Removed official files (in old manifest but not new) are cleaned up
+ * - User-created files (never in any manifest) are preserved
+ * - Skips if already installed at the same version
+ *
+ * Only runs on global install (npm install -g) or explicit OPENCLI_FETCH=1.
+ * No network calls — copies directly from dist/clis/ in the installed package.
+ *
+ * This is an ESM script (package.json type: module). No TypeScript, no src/ imports.
+ */
+
+import { existsSync, mkdirSync, rmSync, cpSync, readFileSync, writeFileSync, readdirSync, statSync, unlinkSync } from 'node:fs';
+import { join, resolve, dirname } from 'node:path';
+import { homedir } from 'node:os';
+
+const OPENCLI_DIR = join(homedir(), '.opencli');
+const USER_CLIS_DIR = join(OPENCLI_DIR, 'clis');
+const MANIFEST_PATH = join(OPENCLI_DIR, 'adapter-manifest.json');
+const PACKAGE_ROOT = resolve(import.meta.dirname, '..');
+const BUILTIN_CLIS = join(PACKAGE_ROOT, 'dist', 'clis');
+
+function log(msg) {
+  console.log(`[opencli] ${msg}`);
+}
+
+function getPackageVersion() {
+  try {
+    return JSON.parse(readFileSync(join(PACKAGE_ROOT, 'package.json'), 'utf-8')).version;
+  } catch {
+    return 'unknown';
+  }
+}
+
+/**
+ * Read existing manifest. Returns { version, files } or null.
+ */
+function readManifest() {
+  try {
+    return JSON.parse(readFileSync(MANIFEST_PATH, 'utf-8'));
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * Collect all relative file paths under a directory.
+ */
+function walkFiles(dir, prefix = '') {
+  const results = [];
+  if (!existsSync(dir)) return results;
+  for (const entry of readdirSync(dir)) {
+    const full = join(dir, entry);
+    const rel = prefix ? `${prefix}/${entry}` : entry;
+    if (statSync(full).isDirectory()) {
+      results.push(...walkFiles(full, rel));
+    } else {
+      results.push(rel);
+    }
+  }
+  return results;
+}
+
+/**
+ * Remove empty parent directories up to (but not including) stopAt.
+ */
+function pruneEmptyDirs(filePath, stopAt) {
+  let dir = dirname(filePath);
+  while (dir !== stopAt && dir.startsWith(stopAt)) {
+    try {
+      const entries = readdirSync(dir);
+      if (entries.length > 0) break;
+      rmSync(dir);
+      dir = dirname(dir);
+    } catch {
+      break;
+    }
+  }
+}
+
+export function fetchAdapters() {
+  const currentVersion = getPackageVersion();
+  const oldManifest = readManifest();
+
+  // Skip if already installed at the same version (unless forced via OPENCLI_FETCH=1)
+  const isForced = process.env.OPENCLI_FETCH === '1';
+  if (!isForced && currentVersion !== 'unknown' && oldManifest?.version === currentVersion) {
+    log(`Adapters already up to date (v${currentVersion})`);
+    return;
+  }
+
+  if (!existsSync(BUILTIN_CLIS)) {
+    log('Warning: dist/clis/ not found in package — skipping adapter copy');
+    return;
+  }
+
+  const newOfficialFiles = new Set(walkFiles(BUILTIN_CLIS));
+  const oldOfficialFiles = new Set(oldManifest?.files ?? []);
+  mkdirSync(USER_CLIS_DIR, { recursive: true });
+
+  // 1. Copy official files (unconditionally overwrite)
+  let copied = 0;
+  for (const relPath of newOfficialFiles) {
+    const src = join(BUILTIN_CLIS, relPath);
+    const dst = join(USER_CLIS_DIR, relPath);
+    mkdirSync(dirname(dst), { recursive: true });
+    cpSync(src, dst, { force: true });
+    copied++;
+  }
+
+  // 2. Remove files that were official but are no longer (upstream deleted)
+  let removed = 0;
+  for (const relPath of oldOfficialFiles) {
+    if (!newOfficialFiles.has(relPath)) {
+      const dst = join(USER_CLIS_DIR, relPath);
+      try {
+        unlinkSync(dst);
+        pruneEmptyDirs(dst, USER_CLIS_DIR);
+        removed++;
+      } catch {
+        // File may not exist locally
+      }
+    }
+  }
+
+  // 3. Write updated manifest
+  writeFileSync(MANIFEST_PATH, JSON.stringify({
+    version: currentVersion,
+    files: [...newOfficialFiles].sort(),
+    updatedAt: new Date().toISOString(),
+  }, null, 2));
+
+  log(`Installed ${copied} adapter files to ${USER_CLIS_DIR}` +
+    (removed > 0 ? `, removed ${removed} deprecated files` : ''));
+}
+
+function main() {
+  // Skip in CI
+  if (process.env.CI || process.env.CONTINUOUS_INTEGRATION) return;
+  // Allow opt-out
+  if (process.env.OPENCLI_SKIP_FETCH === '1') return;
+
+  // Only run on global install, explicit trigger, or first-run fallback
+  const isGlobal = process.env.npm_config_global === 'true';
+  const isExplicit = process.env.OPENCLI_FETCH === '1';
+  const isFirstRun = process.env._OPENCLI_FIRST_RUN === '1';
+  if (!isGlobal && !isExplicit && !isFirstRun) return;
+
+  fetchAdapters();
+}
+
+main();

package/vendor/opencli/scripts/postinstall.js

@@ -0,0 +1,173 @@
+#!/usr/bin/env node
+
+/**
+ * postinstall script — install shell completion files and print setup instructions.
+ *
+ * Detects the user's default shell and writes the completion script to the
+ * standard completion directory.  For zsh and bash, the script prints manual
+ * instructions instead of modifying rc files (~/.zshrc, ~/.bashrc) — this
+ * avoids breaking multi-line shell commands and other fragile rc structures.
+ * Fish completions work automatically without rc changes.
+ *
+ * Supported shells: bash, zsh, fish.
+ *
+ * This script is intentionally plain Node.js (no TypeScript, no imports from
+ * the main source tree) so that it can run without a build step.
+ */
+
+import { mkdirSync, writeFileSync, existsSync } from 'node:fs';
+import { join } from 'node:path';
+import { homedir } from 'node:os';
+
+
+// ── Completion script content ──────────────────────────────────────────────
+
+const BASH_COMPLETION = `# Bash completion for opencli (auto-installed)
+_opencli_completions() {
+  local cur words cword
+  _get_comp_words_by_ref -n : cur words cword
+
+  local completions
+  completions=$(opencli --get-completions --cursor "$cword" "\${words[@]:1}" 2>/dev/null)
+
+  COMPREPLY=( $(compgen -W "$completions" -- "$cur") )
+  __ltrim_colon_completions "$cur"
+}
+complete -F _opencli_completions opencli
+`;
+
+const ZSH_COMPLETION = `#compdef opencli
+# Zsh completion for opencli (auto-installed)
+_opencli() {
+  local -a completions
+  local cword=$((CURRENT - 1))
+  completions=(\${(f)"$(opencli --get-completions --cursor "$cword" "\${words[@]:1}" 2>/dev/null)"})
+  compadd -a completions
+}
+_opencli
+`;
+
+const FISH_COMPLETION = `# Fish completion for opencli (auto-installed)
+complete -c opencli -f -a '(
+  set -l tokens (commandline -cop)
+  set -l cursor (count (commandline -cop))
+  opencli --get-completions --cursor $cursor $tokens[2..] 2>/dev/null
+)'
+`;
+
+// ── Helpers ────────────────────────────────────────────────────────────────
+
+function detectShell() {
+  const shell = process.env.SHELL || '';
+  if (shell.includes('zsh')) return 'zsh';
+  if (shell.includes('bash')) return 'bash';
+  if (shell.includes('fish')) return 'fish';
+  return null;
+}
+
+function ensureDir(dir) {
+  if (!existsSync(dir)) {
+    mkdirSync(dir, { recursive: true });
+  }
+}
+
+// ── Main ───────────────────────────────────────────────────────────────────
+
+function main() {
+  // Skip in CI environments
+  if (process.env.CI || process.env.CONTINUOUS_INTEGRATION) {
+    return;
+  }
+
+  // Only install completion for global installs and npm link
+  const isGlobal = process.env.npm_config_global === 'true';
+  if (!isGlobal) {
+    return;
+  }
+
+  const shell = detectShell();
+  if (!shell) {
+    // Cannot determine shell; silently skip
+    return;
+  }
+
+  const home = homedir();
+
+  try {
+    switch (shell) {
+      case 'zsh': {
+        const completionsDir = join(home, '.zsh', 'completions');
+        const completionFile = join(completionsDir, '_opencli');
+        ensureDir(completionsDir);
+        writeFileSync(completionFile, ZSH_COMPLETION, 'utf8');
+
+        console.log(`✓ Zsh completion installed to ${completionFile}`);
+        console.log('');
+        console.log('  \x1b[1mTo enable, add these lines to your ~/.zshrc:\x1b[0m');
+        console.log(`    fpath=(${completionsDir} $fpath)`);
+        console.log('    autoload -Uz compinit && compinit');
+        console.log('');
+        console.log('  If you already have compinit (oh-my-zsh, zinit, etc.), just add the fpath line \x1b[1mbefore\x1b[0m it.');
+        console.log('  Then restart your shell or run: \x1b[36mexec zsh\x1b[0m');
+        break;
+      }
+      case 'bash': {
+        const userCompDir = join(home, '.bash_completion.d');
+        const completionFile = join(userCompDir, 'opencli');
+        ensureDir(userCompDir);
+        writeFileSync(completionFile, BASH_COMPLETION, 'utf8');
+
+        console.log(`✓ Bash completion installed to ${completionFile}`);
+        console.log('');
+        console.log('  \x1b[1mTo enable, add this line to your ~/.bashrc:\x1b[0m');
+        console.log(`    [ -f "${completionFile}" ] && source "${completionFile}"`);
+        console.log('');
+        console.log('  Then restart your shell or run: \x1b[36msource ~/.bashrc\x1b[0m');
+        break;
+      }
+      case 'fish': {
+        const completionsDir = join(home, '.config', 'fish', 'completions');
+        const completionFile = join(completionsDir, 'opencli.fish');
+        ensureDir(completionsDir);
+        writeFileSync(completionFile, FISH_COMPLETION, 'utf8');
+
+        console.log(`✓ Fish completion installed to ${completionFile}`);
+        console.log(`  Restart your shell to activate.`);
+        break;
+      }
+    }
+  } catch (err) {
+    // Completion install is best-effort; never fail the package install
+    if (process.env.OPENCLI_VERBOSE) {
+      console.error(`Warning: Could not install shell completion: ${err.message}`);
+    }
+  }
+
+  // ── Spotify credentials template ────────────────────────────────────
+  const opencliDir = join(home, '.opencli');
+  const spotifyEnvFile = join(opencliDir, 'spotify.env');
+  ensureDir(opencliDir);
+  if (!existsSync(spotifyEnvFile)) {
+    writeFileSync(spotifyEnvFile,
+      `# Spotify credentials — get them at https://developer.spotify.com/dashboard\n` +
+      `# Add http://127.0.0.1:8888/callback as a Redirect URI in your Spotify app\n` +
+      `SPOTIFY_CLIENT_ID=your_spotify_client_id_here\n` +
+      `SPOTIFY_CLIENT_SECRET=your_spotify_client_secret_here\n`,
+      'utf8'
+    );
+    console.log(`✓ Spotify credentials template created at ${spotifyEnvFile}`);
+    console.log(`  Edit the file and add your Client ID and Secret, then run: opencli spotify auth`);
+  }
+
+  // ── Browser Bridge setup hint ───────────────────────────────────────
+  console.log('');
+  console.log('  \x1b[1mNext step — Browser Bridge setup\x1b[0m');
+  console.log('  Browser commands (bilibili, zhihu, twitter...) require the extension:');
+  console.log('  1. Download: https://github.com/jackwener/opencli/releases');
+  console.log('  2. In Chrome or Chromium, open chrome://extensions → enable Developer Mode → Load unpacked');
+  console.log('');
+  console.log('  Then run \x1b[36mopencli doctor\x1b[0m to verify.');
+  console.log('');
+}
+
+main();

package/vendor/opencli/scripts/test-site.mjs

@@ -0,0 +1,70 @@
+#!/usr/bin/env node
+
+import { spawnSync } from 'node:child_process';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+
+const site = process.argv[2]?.trim();
+
+if (!site) {
+  console.error('Usage: npm run test:site -- <site>');
+  process.exit(1);
+}
+
+const repoRoot = path.resolve(new URL('..', import.meta.url).pathname);
+const srcDir = path.join(repoRoot, 'src');
+
+function runStep(label, command, args) {
+  console.log(`\n==> ${label}`);
+  const result = spawnSync(command, args, {
+    cwd: repoRoot,
+    stdio: 'inherit',
+    env: process.env,
+  });
+
+  if (result.status !== 0) {
+    process.exit(result.status ?? 1);
+  }
+}
+
+function walk(dir) {
+  const files = [];
+  for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+    const fullPath = path.join(dir, entry.name);
+    if (entry.isDirectory()) {
+      files.push(...walk(fullPath));
+    } else {
+      files.push(fullPath);
+    }
+  }
+  return files;
+}
+
+function toPosix(filePath) {
+  return filePath.split(path.sep).join('/');
+}
+
+function findSiteTests() {
+  return walk(srcDir)
+    .filter(filePath => filePath.endsWith('.test.ts'))
+    .filter(filePath => {
+      const normalized = toPosix(path.relative(repoRoot, filePath));
+      return normalized.includes(`/clis/${site}/`) || normalized.includes(`/${site}.test.ts`);
+    })
+    .sort();
+}
+
+runStep('Typecheck', 'npm', ['run', 'typecheck']);
+runStep('Targeted verify', 'npx', ['tsx', 'src/main.ts', 'verify', site]);
+
+const testFiles = findSiteTests();
+if (testFiles.length === 0) {
+  console.log(`\nNo site-specific vitest files found for "${site}". Skipping full vitest run.`);
+  process.exit(0);
+}
+
+runStep(
+  `Site tests (${site})`,
+  'npx',
+  ['vitest', 'run', ...testFiles.map(filePath => path.relative(repoRoot, filePath))],
+);