jackwener__opencli/docs/guide/getting-started.md

Getting Started

Make any website or Electron App your CLI. Zero risk · Reuse Chrome login · AI-powered discovery · Browser + Desktop automation

OpenCLI turns any website or Electron app into a command-line interface — Bilibili, Zhihu, 小红书, Twitter/X, Reddit, YouTube, Antigravity, and many more — powered by browser session reuse and AI-native discovery.

Highlights

• Desktop App Control — Drive Electron apps (Cursor, Codex, ChatGPT, Notion, etc.) directly from the terminal via CDP.
• Browser Automation — browser gives AI agents direct browser control: click, type, extract, screenshot — fully scriptable.
• Website → CLI — Turn any website into a deterministic CLI: 87+ pre-built adapters, or generate your own with opencli generate.
• Account-safe — Reuses Chrome's logged-in state; your credentials never leave the browser.
• AI Agent ready — explore discovers APIs, synthesize generates adapters, cascade finds auth strategies, browser controls the browser directly.
• Zero LLM cost — No tokens consumed at runtime. Run 10,000 times and pay nothing.
• Deterministic — Same command, same output schema, every time. Pipeable, scriptable, CI-friendly.

Quick Start

Install via npm

npm install -g @jackwener/opencli

Basic Usage

opencli list                              # See all commands
opencli hackernews top --limit 5          # Public API, no browser
opencli bilibili hot --limit 5            # Browser command
opencli zhihu hot -f json                 # JSON output

Output Formats

All built-in commands support --format / -f:

opencli bilibili hot -f table   # Default: rich terminal table
opencli bilibili hot -f json    # JSON (pipe to jq or LLMs)
opencli bilibili hot -f yaml    # YAML (human-readable)
opencli bilibili hot -f md      # Markdown
opencli bilibili hot -f csv     # CSV
opencli bilibili hot -v         # Verbose: show pipeline debug

Tab Completion

OpenCLI supports intelligent tab completion to speed up command input:

# Add shell completion to your startup config
echo 'eval "$(opencli completion zsh)"' >> ~/.zshrc              # Zsh
echo 'eval "$(opencli completion bash)"' >> ~/.bashrc            # Bash
echo 'opencli completion fish | source' >> ~/.config/fish/config.fish  # Fish

# Restart your shell, then press Tab to complete:
opencli [Tab]          # Complete site names (bilibili, zhihu, twitter...)
opencli bilibili [Tab] # Complete commands (hot, search, me, download...)

The completion includes:

• All available sites and adapters
• Built-in commands (list, explore, validate...)
• Command aliases
• Real-time updates as you add new adapters

Next Steps

• Installation details
• Browser Bridge setup
• Plugins — extend with community adapters
• All available adapters
• For developers / AI agents
• Add a new Electron app CLI