Dev & Engineering

OpenCLI Adapter Authoring Guide

End-to-end workflow to write and verify an OpenCLI adapter for a new site within 30 minutes.

56/ 100
Use with care

Useful, but reliability, evidence or controls still have material gaps.

See how it was scored ↓
Works as-is in
Codex · Claude Code
Stars
★ 30k
Last updated
17d ago
License
Apache-2.0
browser-automationplaywrightadapter-developmentwebsite-cli
+2site-integrationdata-extraction

What does this skill do, and when should you use it?

This skill guides you through writing an OpenCLI adapter for a new site or adding a new command to an existing site. It provides a complete workflow: recon, API discovery, strategy selection, field decoding, coding, and verification. It emphasizes choosing a data source strategy based on external contract stability (public API, cookie, UI selector, etc.), with a detailed decision tree and fallback paths. The skill uses `opencli browser` commands throughout and requires leveraging site memory to speed up subsequent adapters. It is designed for the OpenCLI ecosystem, ideal for developers who want to build CLI interfaces for websites within OpenCLI.

Runs opencli doctor to check the environment, reads local site memory (endpoints.json, notes.md), performs site recon using opencli browser analyze, discovers API endpoints via network inspection, state extraction, bundle search, or interception, verifies endpoints by direct fetch, selects a strategy based on contract level and writes a strategy note, decodes fields (using field-conventions or decode-playbook), generates an adapter skeleton with opencli browser init, verifies with opencli browser verify and generates fixtures, and finally writes back endpoints, field maps, and notes to ~/.opencli/sites/.

Good fit
  • A developer needs to add a CLI command for a website not yet covered by OpenCLI (e.g., an internal tool).
  • A developer needs to add a new command to an existing adapter (e.g., add 'follow list' to the Bilibili adapter).
  • A developer needs to fix a broken adapter due to site changes, requiring re-recon and data source adjustment.
  • A developer wants to migrate stable UI/DOM scraping to a more stable public API, but needs to assess contract stability.
  • An AI agent wants to wrap website operations into reusable CLI commands for future automation.

How do you install this skill?

Before you use it
  • Core functionality depends on overseas services (GitHub, npm, Chrome Web Store), which may be inaccessible in mainland China networks; prepare alternatives or mirrors.
  • Skill requires reusing user's logged-in sessions; if handling sensitive data, ensure explicit user consent and follow least-privilege principle.
  • No versioning or changelog; maintenance responsibility unclear, upstream changes may affect stability.
  • Static review cannot verify actual execution; validate in real environment before adoption.
Before you start
Your agent needs
  • Shell / CLI
  • Network access
Install first
  • OpenCLI runtime
  • Node.js 20+
  • Browser Bridge extension

This skill is part of the OpenCLI repository. Install the whole skill collection: npx skills add jackwener/opencli, or install only this skill: npx skills add jackwener/opencli --skill opencli-adapter-author. Requires OpenCLI runtime (e.g., OpenCLIApp or npm install -g @jackwener/opencli with Node.js 20+) and a browser bridge extension.

Generic route: install into Claude Code manually (macOS / Linux)
tmp="$(mktemp -d)"
git clone --depth 1 https://github.com/jackwener/OpenCLI.git "$tmp"
mkdir -p ~/.claude/skills
cp -R "$tmp/skills/opencli-adapter-author" ~/.claude/skills/
rm -rf "$tmp"

Generated from the source repository and skill path; it copies only this skill's folder. If the author's install steps above differ, follow those first. To scope it to one project, replace ~/.claude/skills with that project's .claude/skills.

How do you use this skill?

Ensure opencli doctor passes. Read the skill's pre-check (coverage-matrix). Follow the runbook: recon the site, discover API, write strategy note, decode fields, use opencli browser init <site>/<name> to initialize adapter, and validate with opencli browser verify <site>/<name>. Follow the decision tree and fallback paths. Refer to the detailed docs in references/.

What are this skill's strengths and limitations?

Pros
  • Provides a complete, structured workflow from recon to verification, reducing guesswork.
  • Emphasizes contract stability of data sources, helping reduce maintenance costs.
  • Detailed fallback paths and troubleshooting guide.
  • Site memory accelerates subsequent adapter development.
Limitations
  • Designed for the OpenCLI ecosystem, depends on its specific commands and tools.
  • Requires installing and configuring OpenCLI runtime and browser extension first.
  • May be overkill for simple data scraping.
  • No test suite or complete example adapter code provided.

How does this skill compare with similar options?

Side by side with related skills; every score comes from the same FSRS standard.

Skill FS score Stars Last updated License
OpenCLI Adapter Authoring Guide this page 56 · Use with care ★ 30k 17d ago Apache-2.0
OpenCLI AutoFix — Automatic Adapter Repair 58 · Recommended ★ 30k 17d ago Apache-2.0
Playwright Development Guide ✓ Microsoft · Official 45 · Not recommended ★ 97k 3d ago Apache-2.0
playwright-cli Browser Automation Skill 56 · Use with care ★ 11k 13d ago MIT
Playwright Browser Automation ✓ Microsoft · Official 46 · Use with care ★ 97k 3d ago Apache-2.0

Compared to the opencli-browser skill in the same repo, it focuses on writing reusable adapters rather than ad-hoc browser driving.

How did FollowSkills review this skill?

FollowSkills review · FSRS-2.0
Use with care
56/ 100 5-point scale 2.8 / 5
The upstream repository has new commits since this review. The score still applies to the reviewed revision shown and may not cover the latest changes.
1Trust16 / 25 · 3.2/5

Evidence: skill explicitly bounds scope, does not teach bypassing signatures/captchas/risk controls (coverage-matrix.md), requires reusing only legally obtained data; strategy selection has evidence discipline and typed errors prevent silent failures; emphasizes not storing credentials, sanitizing stored data, and verification before writing back. Deductions: no user confirmation mechanism (e.g., confirm before risky actions), relies on logged-in sessions involving sensitive data, but least-privilege scope and permission escalation not explicit; publisher unverified, attribution and update responsibility unclear.

2Reliability7 / 20 · 1.8/5

Evidence: detailed runbook with fallback paths, structured; references real PRs (#1329, #1312) and adapter examples; error handling classification clear. Deductions: no visible test suite or CI evidence covering key paths; unexecuted static review cannot verify commands are reproducible; heavy dependence on external sites and browser state, high uncertainty.

3Adaptability12 / 15 · 4.0/5

Evidence: clear target audience (AI agents writing adapters), scenarios, and quick self-test (coverage-matrix.md three questions); provides non-supported list; semantic trigger conditions clear. Deductions: effectiveness depends on overseas services (GitHub, npm packages, Chrome Web Store), may be restricted in mainland China networks, no alternative provided.

4Convention12 / 15 · 4.0/5

Evidence: documentation well-structured, progressive disclosure (runbook, references), install/dependency notes exist, parameter and naming conventions clear, multiple examples, known limitations and boundaries (coverage-matrix.md), Apache-2.0 license, references to many PRs and files indicate active maintenance. Deductions: no version number or changelog, contributor maintenance responsibility not explicit, update path for upstream dependencies not stated.

5Effectiveness6 / 15 · 2.0/5

Evidence: description clear, goal specific (30-minute closure); multiple adapter examples and fixture patterns show directly usable output format; references PR merge evidence. Deductions: no verifiable end-to-end example or third-party execution evidence, static review cannot confirm actual completion; direct usability of output not verified.

6Verifiability3 / 10 · 1.5/5

Evidence: references real PRs, adapter files, and fixture files as audit material; strategy selection and field decoding have evidence requirements. Deductions: no runnable tests or CI evidence; static review cannot independently reproduce core paths; lacking corroborating sources beyond author's own claims.

1 2 3 4 5 6

Open a dimension to read why it scored that way

Reviewed Aug 07, 2026 Reviewed revision 399c0de2a76e Review evidence[1][2][3][4][5][6][7][8][9][10][11]

Evidence confidence:Low — Mostly static review, author material or a limited demo; useful for discovery, not high-risk decisions.

See the full review method →

FAQ

What environment is required?
Requires Node.js 20+, OpenCLI runtime (or OpenCLIApp), and the browser bridge extension.
Do I need to write code?
Yes, the skill guides writing JavaScript adapter code, but provides templates and examples.
How do I choose the data source strategy?
The skill provides selection rules, prioritizing public API and cookie API, then UI/DOM, and only internal endpoints when necessary.
What if adapter verification fails?
The skill offers fallback paths, such as checking tokens, re-recon, or using the autofix skill.

More skills from this repository

All from jackwener/OpenCLI

Related skills