@askjo/camoufox-browser 1.0.1 → 1.0.3

package/README.md

@@ -35,7 +35,7 @@ This project wraps Camoufox in a simple REST API optimized for AI agents: access
 Install as an OpenClaw plugin for agent tool access:
 
 ```bash
-openclaw plugins install @jo-inc/camoufox-browser
+openclaw plugins install @askjo/camoufox-browser
 ```
 
 Then start the server and configure:

package/package.json

@@ -1,8 +1,44 @@
 {
   "name": "@askjo/camoufox-browser",
-  "version": "1.0.1",
-  "description": "Headless browser automation server for AI agents - REST API with anti-detection, element refs, and session isolation",
+  "version": "1.0.3",
+  "description": "Headless browser automation server and OpenClaw plugin for AI agents - anti-detection, element refs, and session isolation",
   "main": "server-camoufox.js",
+  "license": "MIT",
+  "author": "Jo Inc <hello@askjo.ai>",
+  "homepage": "https://github.com/jo-inc/camoufox-browser#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jo-inc/camoufox-browser.git"
+  },
+  "bugs": {
+    "url": "https://github.com/jo-inc/camoufox-browser/issues"
+  },
+  "keywords": [
+    "browser",
+    "automation",
+    "headless",
+    "scraping",
+    "camoufox",
+    "anti-detection",
+    "ai-agent",
+    "openclaw",
+    "playwright",
+    "firefox"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "server-camoufox.js",
+    "lib/",
+    "plugin.ts",
+    "openclaw.plugin.json",
+    "run-camoufox.sh",
+    "Dockerfile.camoufox",
+    "SKILL.md",
+    "README.md",
+    "LICENSE"
+  ],
   "openclaw": {
     "extensions": ["plugin.ts"]
   },

package/.env.bak

@@ -1,4 +0,0 @@
-PROXY_HOST=166.88.179.132
-PROXY_PORT=46040
-PROXY_USERNAME=NleQYPIiORIbOYT
-PROXY_PASSWORD=936asYRvpdftjI6

package/.github/workflows/deploy.yml

@@ -1,21 +0,0 @@
-name: Deploy to Fly.io
-
-on:
-  push:
-    branches:
-      - master
-      - main
-
-jobs:
-  deploy:
-    name: Deploy to Fly.io
-    runs-on: ubuntu-latest
-    concurrency: deploy-group
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: superfly/flyctl-actions/setup-flyctl@master
-
-      - run: flyctl deploy --remote-only
-        env:
-          FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}

package/AGENTS.md

@@ -1,153 +0,0 @@
-# camoufox-browser Agent Guide
-
-Headless browser automation server for AI agents. Run locally or deploy to any cloud provider.
-
-## Quick Start for Agents
-
-```bash
-# Install and start
-npm install && npm start
-# Server runs on http://localhost:3000
-```
-
-## Core Workflow
-
-1. **Create a tab** → Get `tabId`
-2. **Navigate** → Go to URL or use search macro
-3. **Get snapshot** → Receive page content with element refs (`e1`, `e2`, etc.)
-4. **Interact** → Click/type using refs
-5. **Repeat** steps 3-4 as needed
-
-## API Reference
-
-### Create Tab
-```bash
-POST /tabs
-{"userId": "agent1", "listItemId": "task1", "url": "https://example.com"}
-```
-Returns: `{"tabId": "abc123", "url": "...", "title": "..."}`
-
-### Navigate
-```bash
-POST /tabs/:tabId/navigate
-{"userId": "agent1", "url": "https://google.com"}
-# Or use macro:
-{"userId": "agent1", "macro": "@google_search", "query": "weather today"}
-```
-
-### Get Snapshot
-```bash
-GET /tabs/:tabId/snapshot?userId=agent1
-```
-Returns accessibility tree with refs:
-```
-[heading] Example Domain
-[paragraph] This domain is for use in examples.
-[link e1] More information...
-```
-
-### Click Element
-```bash
-POST /tabs/:tabId/click
-{"userId": "agent1", "ref": "e1"}
-# Or CSS selector:
-{"userId": "agent1", "selector": "button.submit"}
-```
-
-### Type Text
-```bash
-POST /tabs/:tabId/type
-{"userId": "agent1", "ref": "e2", "text": "hello world"}
-# Add enter: {"userId": "agent1", "ref": "e2", "text": "search query", "pressEnter": true}
-```
-
-### Scroll
-```bash
-POST /tabs/:tabId/scroll
-{"userId": "agent1", "direction": "down", "amount": 500}
-```
-
-### Navigation
-```bash
-POST /tabs/:tabId/back     {"userId": "agent1"}
-POST /tabs/:tabId/forward  {"userId": "agent1"}
-POST /tabs/:tabId/refresh  {"userId": "agent1"}
-```
-
-### Get Links
-```bash
-GET /tabs/:tabId/links?userId=agent1&limit=50
-```
-
-### Close Tab
-```bash
-DELETE /tabs/:tabId?userId=agent1
-```
-
-## Search Macros
-
-Use these instead of constructing URLs:
-
-| Macro | Site |
-|-------|------|
-| `@google_search` | Google |
-| `@youtube_search` | YouTube |
-| `@amazon_search` | Amazon |
-| `@reddit_search` | Reddit |
-| `@wikipedia_search` | Wikipedia |
-| `@twitter_search` | Twitter/X |
-| `@yelp_search` | Yelp |
-| `@linkedin_search` | LinkedIn |
-
-## Element Refs
-
-Refs like `e1`, `e2` are stable identifiers for page elements:
-
-1. Call `/snapshot` to get current refs
-2. Use ref in `/click` or `/type`
-3. Refs reset on navigation - get new snapshot after
-
-## Session Management
-
-- `userId` isolates cookies/storage between users
-- `listItemId` groups tabs by conversation/task
-- Sessions timeout after 30 minutes of inactivity
-- Delete all user data: `DELETE /sessions/:userId`
-
-## Running Engines
-
-### Camoufox (Default - Recommended)
-```bash
-npm start
-# Or: ./run-camoufox.sh
-```
-Firefox-based with anti-detection. Bypasses Google captcha.
-
-### Chrome (Legacy)
-```bash
-npm run start:chrome
-# Or: ./run.sh
-```
-Playwright + stealth plugin. May be blocked by Google.
-
-## Testing
-
-```bash
-npm test              # E2E tests
-npm run test:live     # Live Google tests
-npm run test:debug    # With server output
-```
-
-## Docker
-
-```bash
-docker build -f Dockerfile.camoufox -t camoufox-browser .
-docker run -p 3000:3000 camoufox-browser
-```
-
-## Key Files
-
-- `server-camoufox.js` - Camoufox engine (default)
-- `server.js` - Chrome engine (legacy)
-- `Dockerfile.camoufox` - Production container
-- `fly.toml` - Fly.io deployment config

package/experimental/chromium/Dockerfile

@@ -1,35 +0,0 @@
-FROM debian:bookworm-slim
-
-# Install Chromium and dependencies
-RUN apt-get update && apt-get install -y \
-    chromium \
-    fonts-liberation \
-    fonts-noto-color-emoji \
-    libnss3 \
-    libatk-bridge2.0-0 \
-    libdrm2 \
-    libxkbcommon0 \
-    libgbm1 \
-    libasound2 \
-    libxshmfence1 \
-    && rm -rf /var/lib/apt/lists/*
-
-# Install Node.js
-RUN apt-get update && apt-get install -y \
-    nodejs \
-    npm \
-    && rm -rf /var/lib/apt/lists/*
-
-WORKDIR /app
-
-COPY package.json ./
-RUN npm install --production
-
-COPY server.js ./
-
-ENV NODE_ENV=production
-ENV PORT=3000
-
-EXPOSE 3000
-
-CMD ["node", "server.js"]

package/experimental/chromium/README.md

@@ -1,47 +0,0 @@
-# Chromium Engine (Experimental)
-
-Legacy Chromium/Playwright-based browser engine using stealth plugin.
-
-> ⚠️ **Not recommended**: Gets blocked by Google and other anti-bot systems. Use the Camoufox engine instead.
-
-## Why Experimental?
-
-The Playwright + stealth plugin approach is detected by:
-- Google (captcha on search)
-- Cloudflare
-- Many other anti-bot systems
-
-The main Camoufox engine uses Firefox with C++ level fingerprint spoofing, which bypasses these protections.
-
-## Usage
-
-```bash
-# From repo root
-cd experimental/chromium
-
-# Install dependencies (from repo root)
-npm install
-
-# Run (requires Chromium installed)
-CHROMIUM_PATH=/usr/bin/chromium node server.js
-```
-
-## Docker
-
-```bash
-docker build -t camoufox-browser-chromium .
-docker run -p 3000:3000 camoufox-browser-chromium
-```
-
-## API
-
-Same API as the main Camoufox engine - see root [README.md](../../README.md).
-
-## When to Use
-
-Only use this if:
-- You're accessing sites that don't have anti-bot protection
-- You need Chromium-specific features
-- You're debugging Playwright issues
-
-For all other cases, use `./run-camoufox.sh` from the repo root.

package/experimental/chromium/run.sh

@@ -1,24 +0,0 @@
-#!/bin/bash
-# Local development script for jo-browser with auto-reload
-
-# Use Playwright's bundled Chromium (has full accessibility API support)
-# Only set CHROMIUM_PATH for Docker/production where we install Chromium separately
-unset CHROMIUM_PATH
-
-# Install deps if needed
-if [ ! -d "node_modules" ]; then
-    echo "Installing dependencies..."
-    npm install
-fi
-
-# Install nodemon globally if not available
-if ! command -v nodemon &> /dev/null; then
-    echo "Installing nodemon..."
-    npm install -g nodemon
-fi
-
-echo "Starting jo-browser on http://localhost:3000 (with auto-reload)"
-echo "Logs: /tmp/jo-browser.log"
-nodemon --watch server.js --exec "node server.js" 2>&1 | while IFS= read -r line; do
-  echo "[$(date '+%Y-%m-%d %H:%M:%S')] $line"
-done | tee -a /tmp/jo-browser.log