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

Files

T

jakevin 70b1145b5e refactor: migrate all CLI adapters from YAML to TypeScript (#887 )

* refactor: remove version field from GenerateOutcome and EarlyHint

All consumers are in the same repo and evolve together — version field
adds ceremony without practical value at this stage.

Keeps schema_version in VerifiedArtifactMetadata (sidecar file format).

* refactor: migrate all 123 CLI adapters from YAML to TypeScript

Remove YAML as an adapter format entirely. All adapters now use
TypeScript with cli() from @jackwener/opencli/registry.

- Convert 123 YAML adapter files to TypeScript via batch script
- Remove YAML scanning from discovery.ts (registerYamlCli, yaml import)
- Remove scanYaml() and shouldReplaceManifestEntry() from build-manifest.ts
- Change synthesize.ts to output JSON candidates (internal format)
- Change generate-verified.ts to write .ts adapter files instead of .yaml
- Delete yaml-schema.ts (dead code) and scripts/yaml-to-ts.mjs (one-time tool)
- Update all tests to match new format

Closes discussion in #OpenCLI thread 47ddba82.

* fix: close YAML migration gaps in plugin scaffold, validation, and scan

- plugin-scaffold.ts: generate hello.ts (TS pipeline) instead of hello.yaml
- plugin.ts validatePluginStructure: no longer accept .yaml as valid command file
- plugin.ts scanPluginCommands: remove .yaml/.yml from scanned extensions
- discovery.ts: add explicit log.warn() when YAML files detected in clis/ or plugins/
- plugin.test.ts: update all test fixtures from .yaml to .js
- plugin-scaffold.test.ts: update hello.yaml references to hello.ts
- Delete dead src/yaml-schema.ts

Resolves PR #887 review blockers from @mbp-codex-pr0.

* refactor: complete YAML removal across docs, skills, record, and binance adapters

Code changes:
- record.ts: candidate output changed from .yaml (yaml.dump) to .json (JSON.stringify), removed js-yaml import
- src/clis/binance: convert all 11 YAML adapters to TypeScript cli() format
- binance/commands.test.ts: rewrite to use registry instead of yaml.load
- skill-generate.test.ts, diagnostic.test.ts: update mock paths from .yaml to .ts
- build-manifest.ts, synthesize.ts: update stale YAML comments

Documentation:
- README.md: remove .yaml from Dynamic Loader, fix plugin types, fix synthesize comment
- README.zh-CN.md: fix synthesize comment
- CONTRIBUTING.md: replace YAML Adapter section with Pipeline Adapter (TS), update arg examples
- docs/developer/yaml-adapter.md: replaced with deprecation redirect
- docs/developer/architecture.md: remove YAML pipeline references
- docs/developer/contributing.md: remove YAML adapter section
- docs/developer/ai-workflow.md: YAML → TS in synthesize description
- docs/guide/getting-started.md: remove .yaml from loader, update engine description
- docs/guide/plugins.md: remove YAML plugin option, update plugin types
- docs/index.md, docs/comparison.md: remove YAML adapter references
- docs/zh/guide/plugins.md: remove .yaml from scan description

Skills:
- opencli-explorer/SKILL.md: rewrite YAML vs TS decision tree to TS-only
- opencli-oneshot/SKILL.md: replace YAML templates with TS cli() templates
- opencli-generate/SKILL.md: YAML artifact path → TS artifact path
- opencli-usage/SKILL.md, plugins.md: update adapter format references

* fix: clean up remaining YAML adapter references in docs

- docs/zh/guide/plugins.md: replace YAML plugin example with TS pipeline
- docs/developer/testing.md: YAML Adapter heading → Adapter, remove validate line
- TESTING.md: same fix in root testing doc
- CONTRIBUTING.md: remove "YAML validation" comment
- docs/.vitepress/config.mts: mark YAML Adapter Guide as (Deprecated) in nav
- docs/advanced/download.md: remove "YAML Adapters" from pipeline step heading

2026-04-08 23:01:08 +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 opencli-oneshot skill.

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 TS 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 <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 opencli-explorer skill.

1.8 KiB Raw Permalink Blame History