@jackwener/opencli 1.6.1 → 1.6.3

package/package.json

@@ -1,35 +1,53 @@
 {
   "name": "@jackwener/opencli",
-  "version": "1.6.1",
+  "version": "1.6.3",
   "publishConfig": {
     "access": "public"
   },
-  "description": "Make any website your CLI. AI-powered.",
+  "description": "Make any website or Electron App your CLI. AI-powered.",
   "engines": {
     "node": ">=20.0.0"
   },
   "type": "module",
-  "main": "dist/main.js",
+  "main": "dist/src/main.js",
   "bin": {
-    "opencli": "dist/main.js"
+    "opencli": "dist/src/main.js"
   },
   "exports": {
-    ".": "./dist/main.js",
-    "./registry": "./dist/registry-api.js"
+    ".": "./dist/src/main.js",
+    "./registry": "./dist/src/registry-api.js"
   },
+  "files": [
+    "dist/src/",
+    "dist/clis/",
+    "dist/cli-manifest.json",
+    "dist/registry.*",
+    "dist/errors.*",
+    "dist/types.*",
+    "dist/utils.*",
+    "dist/logger.*",
+    "dist/launcher.*",
+    "dist/browser/",
+    "dist/download/",
+    "dist/pipeline/",
+    "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/build-manifest.js",
+    "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/main.js",
-    "start:bun": "bun dist/main.js",
-    "postinstall": "node scripts/postinstall.js || true",
+    "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",

package/scripts/check-doc-coverage.sh

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-# check-doc-coverage.sh — Verify every adapter in src/clis/ has a doc page.
+# check-doc-coverage.sh — Verify every adapter in clis/ has a doc page.
 #
 # Exit codes:
 #   0 — all adapters have docs
@@ -19,7 +19,7 @@ fi
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 ROOT_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"
 
-SRC_DIR="$ROOT_DIR/src/clis"
+SRC_DIR="$ROOT_DIR/clis"
 DOCS_DIR="$ROOT_DIR/docs/adapters"
 
 missing=()

package/scripts/copy-yaml.cjs

@@ -1,5 +1,5 @@
 /**
- * Copy YAML files from src/clis/ to dist/clis/.
+ * Copy YAML files from clis/ to dist/clis/.
  */
 const { readdirSync, copyFileSync, mkdirSync, existsSync, statSync } = require('fs');
 const path = require('path');
@@ -18,11 +18,11 @@ function walk(src, dst) {
   }
 }
 
-walk('src/clis', 'dist/clis');
+walk('clis', 'dist/clis');
 
 // Copy external CLI registry to dist/
 const extSrc = 'src/external-clis.yaml';
 if (existsSync(extSrc)) {
-  mkdirSync('dist', { recursive: true });
-  copyFileSync(extSrc, 'dist/external-clis.yaml');
+  mkdirSync('dist/src', { recursive: true });
+  copyFileSync(extSrc, 'dist/src/external-clis.yaml');
 }

package/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/scripts/postinstall.js

@@ -217,7 +217,7 @@ function main() {
   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. Open chrome://extensions → enable Developer Mode → Load unpacked');
+  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('');

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,83 +0,0 @@
-name: "🐛 Bug Report"
-description: Report a bug or unexpected behavior in OpenCLI
-title: "[Bug]: "
-labels: ["bug"]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for taking the time to report a bug. A short reproduction and any error output are usually enough.
-
-  - type: textarea
-    id: description
-    attributes:
-      label: Description
-      description: A clear and concise description of the bug.
-      placeholder: What happened?
-    validations:
-      required: true
-
-  - type: textarea
-    id: steps
-    attributes:
-      label: Steps to Reproduce
-      description: How can we reproduce this behavior?
-      value: |
-        1. Run `opencli ...`
-        2. ...
-        3. See error
-    validations:
-      required: true
-
-  - type: textarea
-    id: expected
-    attributes:
-      label: Expected Behavior
-      description: What did you expect to happen?
-    validations:
-      required: true
-
-  - type: input
-    id: version
-    attributes:
-      label: OpenCLI Version
-      description: "Run `opencli --version` to find out."
-      placeholder: "0.8.0"
-    validations:
-      required: true
-
-  - type: dropdown
-    id: node-version
-    attributes:
-      label: Node.js Version
-      options:
-        - "20.x"
-        - "22.x"
-        - Other
-    validations:
-      required: true
-
-  - type: dropdown
-    id: os
-    attributes:
-      label: Operating System
-      options:
-        - macOS
-        - Linux
-        - Windows
-        - Other
-    validations:
-      required: true
-
-  - type: textarea
-    id: logs
-    attributes:
-      label: Logs / Screenshots
-      description: |
-        Paste any relevant error output. Run with `-v` for verbose logs:
-        ```
-        opencli <command> -v
-        ```
-      render: shell
-    validations:
-      required: false

package/.github/ISSUE_TEMPLATE/config.yml

@@ -1,8 +0,0 @@
-blank_issues_enabled: true
-contact_links:
-  - name: 📖 Documentation
-    url: https://github.com/jackwener/opencli#readme
-    about: Check the README and docs before opening an issue.
-  - name: 🧪 Testing Guide
-    url: https://github.com/jackwener/opencli/blob/main/TESTING.md
-    about: How to run and write tests for OpenCLI.

package/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,42 +0,0 @@
-name: "✨ Feature Request"
-description: Suggest a new feature or improvement
-title: "[Feature]: "
-labels: ["enhancement"]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Have an idea to make OpenCLI better? We'd love to hear it!
-
-  - type: textarea
-    id: description
-    attributes:
-      label: Feature Description
-      description: A clear and concise description of the feature you'd like.
-    validations:
-      required: true
-
-  - type: textarea
-    id: use-case
-    attributes:
-      label: Use Case
-      description: What problem does this solve? Who benefits from this feature?
-      placeholder: "As a user, I want to ... so that ..."
-    validations:
-      required: true
-
-  - type: textarea
-    id: proposed-solution
-    attributes:
-      label: Proposed Solution
-      description: If you have a specific implementation in mind, describe it here.
-    validations:
-      required: false
-
-  - type: textarea
-    id: alternatives
-    attributes:
-      label: Alternatives Considered
-      description: Any alternative approaches you've thought about?
-    validations:
-      required: false

package/.github/ISSUE_TEMPLATE/new_site_adapter.yml

@@ -1,57 +0,0 @@
-name: "🌐 New Site Adapter Request"
-description: Request support for a new website
-title: "[Site]: "
-labels: ["new-adapter"]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Want OpenCLI to support a new site? Tell us about it!
-
-  - type: input
-    id: site-name
-    attributes:
-      label: Site Name
-      description: The name of the website.
-      placeholder: "e.g. Product Hunt"
-    validations:
-      required: true
-
-  - type: input
-    id: site-url
-    attributes:
-      label: Site URL
-      description: The main URL of the website.
-      placeholder: "https://www.producthunt.com"
-    validations:
-      required: true
-
-  - type: textarea
-    id: commands
-    attributes:
-      label: Desired Commands
-      description: What commands would you like? List them with a brief description.
-      value: |
-        - `hot` — trending / popular items
-        - `search` — search the site
-    validations:
-      required: true
-
-  - type: textarea
-    id: api-examples
-    attributes:
-      label: Example Links or API Endpoints
-      description: Share any example page URLs or API endpoints if you have them (optional).
-      placeholder: |
-        Example page: https://www.producthunt.com/posts/example
-        GET https://api.producthunt.com/v2/posts?order=votes
-        Response: { "posts": [{ "name": "...", "tagline": "..." }] }
-    validations:
-      required: false
-
-  - type: checkboxes
-    id: contribution
-    attributes:
-      label: Willing to Contribute?
-      options:
-        - label: I'm willing to submit a PR for this adapter

package/.github/actions/setup-chrome/action.yml

@@ -1,27 +0,0 @@
-name: Setup Chrome
-description: Install real Chrome for browser testing (with xvfb on Linux)
-
-outputs:
-  chrome-path:
-    description: Path to the installed Chrome binary
-    value: ${{ steps.setup-chrome.outputs.chrome-path }}
-
-runs:
-  using: composite
-  steps:
-    - name: Install real Chrome (stable)
-      uses: browser-actions/setup-chrome@v1
-      id: setup-chrome
-      with:
-        chrome-version: stable
-
-    - name: Verify Chrome installation
-      shell: bash
-      run: |
-        echo "Chrome path: ${{ steps.setup-chrome.outputs.chrome-path }}"
-        "${{ steps.setup-chrome.outputs.chrome-path }}" --version
-
-    - name: Install xvfb (Linux only)
-      if: runner.os == 'Linux'
-      shell: bash
-      run: sudo apt-get install -y xvfb

package/.github/dependabot.yml

@@ -1,27 +0,0 @@
-version: 2
-
-updates:
-  # npm dependencies
-  - package-ecosystem: "npm"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-      day: "monday"
-    open-pull-requests-limit: 10
-    labels:
-      - "dependencies"
-    commit-message:
-      prefix: "chore(deps)"
-
-  # GitHub Actions
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-      day: "monday"
-    open-pull-requests-limit: 5
-    labels:
-      - "dependencies"
-      - "ci"
-    commit-message:
-      prefix: "chore(ci)"

package/.github/pull_request_template.md

@@ -1,33 +0,0 @@
-## Description
-
-<!-- Briefly describe your changes and link to any related issues. -->
-
-Related issue:
-
-## Type of Change
-
-- [ ] 🐛 Bug fix
-- [ ] ✨ New feature
-- [ ] 🌐 New site adapter
-- [ ] 📝 Documentation
-- [ ] ♻️ Refactor
-- [ ] 🔧 CI / build / tooling
-
-## Checklist
-
-- [ ] I ran the checks relevant to this PR
-- [ ] I updated tests or docs if needed
-- [ ] I included output or screenshots when useful
-
-### Documentation (if adding/modifying an adapter)
-
-- [ ] Added doc page under `docs/adapters/` (if new adapter)
-- [ ] Updated `docs/adapters/index.md` table (if new adapter)
-- [ ] Updated sidebar in `docs/.vitepress/config.mts` (if new adapter)
-- [ ] Updated `README.md` / `README.zh-CN.md` when command discoverability changed
-- [ ] Used positional args for the command's primary subject unless a named flag is clearly better
-- [ ] Normalized expected adapter failures to `CliError` subclasses instead of raw `Error`
-
-## Screenshots / Output
-
-<!-- If applicable, paste CLI output or screenshots here. -->

package/.github/workflows/build-extension.yml

@@ -1,67 +0,0 @@
-name: Build Chrome Extension
-
-on:
-  push:
-    branches: [ "main" ]
-    tags: [ "v*.*.*" ]
-    paths:
-      - 'extension/**'
-      - '.github/workflows/build-extension.yml'
-  pull_request:
-    branches: [ "main" ]
-    paths:
-      - 'extension/**'
-      - '.github/workflows/build-extension.yml'
-
-permissions:
-  contents: write
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v6
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v6
-        with:
-          node-version: 20
-          cache: 'npm'
-          cache-dependency-path: extension/package-lock.json
-
-      - name: Install extension dependencies
-        run: npm ci
-        working-directory: extension
-
-      - name: Build extension
-        run: npm run build
-        working-directory: extension
-
-      - name: Prepare extension package
-        run: npm run package:release -- --out ../extension-package
-        working-directory: extension
-
-      - name: Create Extension ZIP
-        run: |
-          cd extension-package
-          zip -r ../opencli-extension.zip .
-
-      - name: Upload Artifacts (Action Run)
-        uses: actions/upload-artifact@v7
-        with:
-          name: opencli-extension-build
-          path: |
-            opencli-extension.zip
-          retention-days: 7
-
-      - name: Attach to GitHub Release
-        if: startsWith(github.ref, 'refs/tags/')
-        uses: softprops/action-gh-release@v2.6.1
-        with:
-          files: |
-            opencli-extension.zip
-          draft: false
-          prerelease: false
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}