mirror of https://github.com/jackwener/OpenCLI.git synced 2026-09-14 18:25:42 +08:00

Files

T

AlexYue 31f58ae699 docs: add VitePress documentation site (#112 )

- Add VitePress with full navigation, sidebar, i18n (en/zh), local search
- Create 50+ doc pages: guide, adapters (browser + desktop), developer, advanced
- Migrate content from README.md, CONTRIBUTING.md, TESTING.md, CDP.md, CLI-ELECTRON.md
- Migrate all 11 adapter READMEs to structured documentation
- Add new pages: architecture, yaml-adapter guide, ts-adapter guide, ai-workflow
- Add GitHub Actions workflow for deploying to GitHub Pages
- Add Chinese locale pages (getting-started, installation, browser-bridge, etc.)
- Add docs:dev, docs:build, docs:preview npm scripts

2026-03-20 14:11:56 +08:00

1.8 KiB

Raw Permalink Blame History

AI Workflow

OpenCLI is designed with AI agents in mind. This guide covers the AI-native discovery and code generation tools.

Quick Mode (One-Shot)

Generate a single command for a specific page URL — just a URL + one-line goal, 4 steps done:

opencli generate https://example.com --goal "trending"

This runs: explore → synthesize → register in one shot.

For the complete one-shot workflow details, see CLI-ONESHOT.md.

Full Mode (Explorer Workflow)

Step 1: Deep Explore

Discover APIs, infer capabilities, and detect framework:

opencli explore https://example.com --site mysite

Outputs to .opencli/explore/<site>/:

manifest.json — Site metadata
endpoints.json — Discovered API endpoints
capabilities.json — Inferred capabilities
auth.json — Authentication strategy details

Step 2: Synthesize

Generate YAML adapters from explore artifacts:

opencli synthesize mysite

Step 3: Strategy Cascade

Auto-probe authentication strategies: PUBLIC → COOKIE → HEADER:

opencli cascade https://api.example.com/data

Step 4: Validate & Test

opencli validate                           # Validate generated YAML
opencli <site> <command> --limit 3 -f json # Test the command

5-Tier Authentication Strategy

The explorer uses a decision tree to determine the best authentication approach:

PUBLIC — No auth, direct API call
COOKIE — Reuse Chrome session cookies
HEADER — Custom auth headers
BROWSER — Full browser automation
CDP — Chrome DevTools Protocol for Electron apps

For the complete browser exploration workflow and debugging guide, see CLI-EXPLORER.md.

1.8 KiB Raw Permalink Blame History