diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..fcadb2c --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text eol=lf diff --git a/README.md b/README.md index 9ad1157..40ea147 100644 --- a/README.md +++ b/README.md @@ -49,45 +49,15 @@ https://github.com/user-attachments/assets/04eceadc-d398-4303-984d-ae3197bfa664 ## Quick Start -### Codex +### Agent prompt -In Codex, open **Plugins**, choose **Add plugin marketplace**, and enter either -`agentrhq/webcmd` or `https://github.com/agentrhq/webcmd`. Install **Webcmd** -from that marketplace, then start a new task. On first use, the plugin installs -the npm CLI automatically if `webcmd` is missing. - -The plugin includes all seven bundled Webcmd skills. Do not also add those -skills with `webcmd skills add` in Codex. - -### Other agents or plugin-free setup - -Webcmd requires Node.js 20.6+. - -```bash -npm install -g @agentrhq/webcmd -``` - -The npm package ships the Webcmd core and browser commands, but no site -adapters. Search the plugin catalog and explicitly install the adapter you -need: - -```bash -webcmd plugin search -f json -webcmd plugin install -``` - -```bash -webcmd skills add +```text +Fetch and follow https://raw.githubusercontent.com/agentrhq/webcmd/main/start.md to set up Webcmd end to end. ``` -When prompted, choose Claude, Codex, another supported harness, or a custom -skills path. - -In your agent harness, load or tag `webcmd-usage`, then describe the outcome you want. +### Manual -```text -Use webcmd to research the latest discussions about browser automation across Hacker News and Reddit, then return a concise comparison with source links. -``` +Refer to the [Quickstart](https://webcmd.dev/docs/quickstart) docs for step-by-step manual setup. ## What You Can Ask diff --git a/docs/agents/claude-code.md b/docs/agents/claude-code.md index 751a41b..ec7253d 100644 --- a/docs/agents/claude-code.md +++ b/docs/agents/claude-code.md @@ -3,13 +3,11 @@ title: Claude Code Agent sidebarTitle: Claude Code --- -> **Agent prompt** -> -> Fetch and follow [start.md](https://raw.githubusercontent.com/agentrhq/webcmd/main/start.md) to set up Webcmd end to end, then read this page's Manual — especially [Override default tools](#override-default-tools) — before doing browser work. +## Agent prompt -> Use Webcmd with [Claude Code](https://code.claude.com) to replace its native `WebFetch` and `WebSearch` tools with the Webcmd browser surface. - -Claude Code's native web tools are lossy by design: `WebFetch` summarizes a page with a small extraction model and `WebSearch` returns result titles and URLs but cannot read the pages. Point Claude Code at Webcmd's browser CLI instead: adapters return exact, stable fields, and `webcmd browser` sessions render real pages with logged-in profiles. Claude Code runs `webcmd` through its Bash tool. +```text +Fetch and follow https://raw.githubusercontent.com/agentrhq/webcmd/main/start.md to set up Webcmd end to end. +``` ## Manual diff --git a/docs/agents/codex-cli.md b/docs/agents/codex-cli.md index 125775d..f184d2d 100644 --- a/docs/agents/codex-cli.md +++ b/docs/agents/codex-cli.md @@ -3,13 +3,11 @@ title: Codex CLI Agent sidebarTitle: Codex CLI --- -> **Agent prompt** -> -> Fetch and follow [start.md](https://raw.githubusercontent.com/agentrhq/webcmd/main/start.md) to set up Webcmd end to end, then read this page's Manual — especially [Override default tools](#override-default-tools) — before doing browser work. +## Agent prompt -> Use Webcmd with [Codex CLI](https://developers.openai.com/codex/) to replace its native `web_search` tool with the Webcmd browser surface. - -Codex CLI's native `web_search` tool returns cached or indexed search results but cannot read pages or run authenticated sessions. Point Codex at Webcmd's browser CLI instead: adapters return exact, stable fields, and `webcmd browser` sessions render real pages with logged-in profiles. Codex runs `webcmd` through its shell tool. +```text +Fetch and follow https://raw.githubusercontent.com/agentrhq/webcmd/main/start.md to set up Webcmd end to end. +``` ## Manual diff --git a/docs/agents/cursor.md b/docs/agents/cursor.md index 9373ca9..6b13914 100644 --- a/docs/agents/cursor.md +++ b/docs/agents/cursor.md @@ -3,13 +3,11 @@ title: Cursor Agent sidebarTitle: Cursor --- -> **Agent prompt** -> -> Fetch and follow [start.md](https://raw.githubusercontent.com/agentrhq/webcmd/main/start.md) to set up Webcmd end to end, then read this page's Manual — especially [Override default tools](#override-default-tools) — before doing browser work. +## Agent prompt -> Use Webcmd with [Cursor](https://cursor.com) to replace its built-in Browser and Web tools with Webcmd's adapters and `webcmd browser` sessions. - -Point Cursor's agent at Webcmd's browser CLI to replace its native Browser (navigate/click/screenshot) and Web (search/fetch) tools with Webcmd's adapters and `webcmd browser` sessions. Cursor's agent drives Webcmd through its shell tool. Adapter-first commands and compact snapshots usually use fewer tokens than Cursor's native web tools. +```text +Fetch and follow https://raw.githubusercontent.com/agentrhq/webcmd/main/start.md to set up Webcmd end to end. +``` ## Manual diff --git a/docs/agents/hermes.md b/docs/agents/hermes.md index bc3abe5..bfb42d8 100644 --- a/docs/agents/hermes.md +++ b/docs/agents/hermes.md @@ -3,13 +3,11 @@ title: Hermes Agent sidebarTitle: Hermes --- -> **Agent prompt** -> -> Fetch and follow [start.md](https://raw.githubusercontent.com/agentrhq/webcmd/main/start.md) to set up Webcmd end to end, then read this page's Manual — especially [Override default tools](#override-default-tools) — before doing browser work. +## Agent prompt -> Use Webcmd with [Hermes Agent](https://hermes-agent.nousresearch.com/docs) to replace its built-in `browser_*` stack with Webcmd's adapters and `webcmd browser` sessions. - -Point Hermes at Webcmd's browser CLI to replace its native browser toolset with Webcmd's adapters and `webcmd browser` sessions. Hermes drives Webcmd through its `terminal` toolset. Adapter-first commands and compact snapshots usually use fewer tokens than Hermes' native browser tools. +```text +Fetch and follow https://raw.githubusercontent.com/agentrhq/webcmd/main/start.md to set up Webcmd end to end. +``` ## Manual diff --git a/docs/agents/openclaw.md b/docs/agents/openclaw.md index f4294b9..2525697 100644 --- a/docs/agents/openclaw.md +++ b/docs/agents/openclaw.md @@ -3,13 +3,11 @@ title: OpenClaw Agent sidebarTitle: OpenClaw --- -> **Agent prompt** -> -> Fetch and follow [start.md](https://raw.githubusercontent.com/agentrhq/webcmd/main/start.md) to set up Webcmd end to end, then read this page's Manual — especially [Override default tools](#override-default-tools) — before doing browser work. +## Agent prompt -> Use Webcmd with [OpenClaw](https://openclaw.ai) to replace its built-in `web_search`, `web_fetch`, and `browser` tools with the Webcmd browser surface. - -OpenClaw ships core web tools (`web_search`, `web_fetch`, `browser`, `browser_visual`, `search_news`) plus a Playwright-based browser. Point OpenClaw at Webcmd's browser CLI instead: adapters return exact, stable fields, and `webcmd browser` sessions keep logged-in profiles. OpenClaw runs `webcmd` through its `exec` tool. +```text +Fetch and follow https://raw.githubusercontent.com/agentrhq/webcmd/main/start.md to set up Webcmd end to end. +``` ## Manual diff --git a/docs/agents/opencode.md b/docs/agents/opencode.md index dec0e31..476f78f 100644 --- a/docs/agents/opencode.md +++ b/docs/agents/opencode.md @@ -3,13 +3,11 @@ title: OpenCode Agent sidebarTitle: OpenCode --- -> **Agent prompt** -> -> Fetch and follow [start.md](https://raw.githubusercontent.com/agentrhq/webcmd/main/start.md) to set up Webcmd end to end, then read this page's Manual — especially [Override default tools](#override-default-tools) — before doing browser work. +## Agent prompt -> Use Webcmd with OpenCode to replace its built-in `webfetch` / `websearch` tools with the Webcmd browser surface. - -Point OpenCode at Webcmd's browser CLI to replace its native browser tools with Webcmd's adapters and `webcmd browser` sessions. Adapter-first commands and compact snapshots usually use fewer tokens than OpenCode's native web tools, and logged-in profiles handle authenticated pages. +```text +Fetch and follow https://raw.githubusercontent.com/agentrhq/webcmd/main/start.md to set up Webcmd end to end. +``` ## Manual diff --git a/docs/agents/pi.md b/docs/agents/pi.md index c0a7082..5dae433 100644 --- a/docs/agents/pi.md +++ b/docs/agents/pi.md @@ -3,13 +3,11 @@ title: Pi Agent sidebarTitle: Pi --- -> **Agent prompt** -> -> Fetch and follow [start.md](https://raw.githubusercontent.com/agentrhq/webcmd/main/start.md) to set up Webcmd end to end, then read this page's Manual — especially [Override default tools](#override-default-tools) — before doing browser work. +## Agent prompt -> Use Webcmd with [Pi](https://pi.dev) to give it a browser surface. Pi ships no built-in web, search, or browser tools, so Webcmd is driven through Pi's default `bash` tool with no permission or config changes. - -Pi is a minimal terminal coding harness whose default tools are filesystem and shell only (`read`, `bash`, `edit`, `write`, with `grep`, `find`, and `ls` available). Its agent drives Webcmd through the `bash` tool. Adapter-first commands and compact snapshots usually use fewer tokens than the official `brave-search` and `browser-tools` skills, and logged-in profiles handle authenticated pages. +```text +Fetch and follow https://raw.githubusercontent.com/agentrhq/webcmd/main/start.md to set up Webcmd end to end. +``` ## Manual