arise-browser 0.1.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 AriseOS
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,247 @@
+<p align="center">
+  <strong>AriseBrowser</strong><br/>
+  Browser engine for AI agents.<br/>
+  Less tokens. Learns from users and agents. Actually clicks the right thing.<br/>
+  Headed mode on servers — watch AI browse in real time via WebRTC.
+</p>
+
+<p align="center">
+  <a href="https://github.com/AriseOS/arise-browser/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square" alt="License"/></a>
+  <img src="https://img.shields.io/badge/Node.js-20+-339933?style=flat-square&logo=node.js&logoColor=white" alt="Node.js 20+"/>
+  <img src="https://img.shields.io/badge/Playwright-powered-2EAD33?style=flat-square&logo=playwright&logoColor=white" alt="Playwright"/>
+</p>
+
+---
+
+## 1. Headed Mode on Servers — Watch AI Browse Live
+
+Most browser automation runs headless — invisible. That's fine until you need to:
+- **Debug why an agent failed** on a page you can't see
+- **Show a client** what the agent is doing in real time
+- **Bypass anti-bot systems** that detect headless mode
+- **Let users intervene** when the agent gets stuck
+
+AriseBrowser's **virtual display mode** runs a real headed Chrome on any Linux server — no physical monitor needed. Users connect via WebRTC in their browser and see exactly what the AI sees:
+
+```bash
+# Install system dependencies (once, Linux only)
+sudo bash <(curl -fsSL https://raw.githubusercontent.com/AriseOS/arise-browser/main/deploy/neko/setup.sh)
+
+# Start with virtual display
+npx arise-browser --virtual-display --host 0.0.0.0
+
+# AI agent uses the API as usual
+curl -X POST http://server:9867/navigate -d '{"url":"https://example.com"}'
+
+# Users open http://server:6090 in their browser → live view of Chrome
+```
+
+Behind the scenes, arise-browser spawns and manages: Xvfb (virtual display) → PulseAudio (audio) → Openbox (window manager) → Chrome (CDP) → Neko (WebRTC streaming). One process, no Docker, no supervisord.
+
+**Why not just use headless?** Anti-bot systems increasingly fingerprint headless environments. A headed Chrome running on a real X11 display is indistinguishable from a human using a desktop — because it *is* a real desktop environment.
+
+## 2. Use Fewer Tokens
+
+Every token your agent spends reading a page is money. AriseBrowser gives your agent a **compact accessibility snapshot** instead of raw HTML:
+
+- **YAML format** — ~50% fewer tokens than equivalent JSON snapshots
+- **Interactive filter** — Only show actionable elements (buttons, links, inputs). Skip the noise.
+- **Diff mode** — After the first snapshot, only send what changed. On a 10-step workflow, this can cut total snapshot tokens by **70%+**.
+
+Your agent sees what it needs to act, nothing more.
+
+## 3. Learn Once, Automate Forever
+
+AriseBrowser has a built-in **behavior recording** system that captures workflows and exports them as structured traces (Learn protocol). Two ways to teach:
+
+### Watch a user work
+
+Record a human demonstrating a task — AriseBrowser captures every click, type, scroll, and navigation:
+
+```
+User demonstrates: "Book a meeting room on Outlook"
+         ↓
+AriseBrowser records every click, type, scroll, navigation
+         ↓
+Export as structured trace (Learn protocol):
+  { task: "book meeting room",
+    steps: [
+      { url: "outlook.com/calendar", action: "click", target: "New Event" },
+      { url: "...", action: "type", target: "Title", value: "Team Standup" },
+      ...
+    ] }
+         ↓
+Feed to your agent's memory / skill system
+         ↓
+Next time: agent does it autonomously
+```
+
+This is how agents go from "follow my script" to "I watched you do it, I know how."
+
+### Learn from agent execution
+
+When your agent completes a task, AriseBrowser can record its actions too. Export the trace and feed it back as a skill — the agent improves with every successful run:
+
+```
+Agent completes: "Fill out expense report on SAP"
+         ↓
+AriseBrowser recorded the entire session
+         ↓
+Export → Learn protocol trace → store as reusable skill
+         ↓
+Next time: agent recalls the skill, executes faster, skips exploration
+```
+
+No other browser automation tool does recording + structured export out of the box.
+
+## 4. Actions That Actually Work
+
+Clicking a button sounds simple — until it's inside a custom dropdown, behind an overlay, or opens a new tab. Other tools dispatch a mouse event at coordinates (0,0) and call it a day.
+
+AriseBrowser uses **multi-strategy execution**:
+
+| Action | How it works |
+|--------|-------------|
+| **Click** | Ctrl+Click (new tab detection) → regular click → force click. Validates something actually changed after each attempt. |
+| **Select** | 12 fallback strategies — native `<select>`, role=option, data-value, aria-label, text match, keyboard fallback. Works on custom dropdowns too. |
+| **Type** | Smart input detection with debounce. Flushes before navigation so nothing gets lost. |
+
+15 action types total: click, type, select, scroll, hover, focus, enter, press_key, navigate, back, forward, wait, extract, mouse_control, mouse_drag.
+
+## 5. Element Refs That Don't Break
+
+Other tools generate element IDs per snapshot — navigate away and they're gone. AriseBrowser uses a **3-layer persistent ref system**:
+
+1. **WeakMap** — Fast in-memory lookup
+2. **aria-ref** — Injected into DOM, survives re-renders
+3. **Signature** — Tag + class + text fingerprint for recovery after navigation
+
+Your agent can reference `e42` from 5 actions ago. It still resolves.
+
+## 6. Multi-Agent Ready
+
+- **Tab Groups** — Organize tabs by task, color-coded
+- **Tab Locks** — TTL-based exclusive access enforced on write routes, prevents two agents from stomping on the same page
+- **Session Registry** — Multiple sessions share one browser
+
+---
+
+## Quick Start
+
+```bash
+npm install
+npm run build
+
+# Headless (default)
+npx arise-browser
+
+# Headed on server (Linux, requires deploy/neko/setup.sh)
+npx arise-browser --virtual-display --host 0.0.0.0
+
+# With auth token
+ARISE_BROWSER_TOKEN=secret npx arise-browser --port 8080
+```
+
+## Connection Modes
+
+| Mode | Use Case | Flag |
+|------|----------|------|
+| **Standalone** | Launch fresh Chromium | (default) |
+| **CDP** | Connect to running Chrome | `--cdp ws://localhost:9222` |
+| **Managed** | Persistent profile (keeps cookies/logins) | `--profile ~/.browser-profile` |
+| **Virtual Display** | Headed Chrome + WebRTC on Linux server | `--virtual-display` |
+
+## API
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/snapshot` | GET | Accessibility tree (YAML/JSON, diff, interactive filter) |
+| `/action` | POST | Execute action (click, type, select, ...) |
+| `/actions` | POST | Batch execute |
+| `/navigate` | POST | Go to URL |
+| `/text` | GET | Page text |
+| `/screenshot` | GET | JPEG screenshot |
+| `/tabs` | GET | List tabs |
+| `/tab` | POST | Create/switch tab |
+| `/tab/lock` | POST | Lock tab (multi-agent) |
+| `/tab/unlock` | POST | Release lock |
+| `/recording/start` | POST | Start recording user behavior |
+| `/recording/stop` | POST | Stop recording |
+| `/recording/export` | POST | Export as Learn protocol |
+| `/evaluate` | POST | Run JavaScript |
+| `/cookies` | GET/POST | Read/write cookies |
+| `/pdf` | GET | PDF export |
+| `/upload` | POST | Upload file |
+| `/download` | GET | Download file |
+| `/health` | GET | Health check |
+
+Notes:
+- Read routes support optional `tabId` where applicable (`/snapshot`, `/text`, `/screenshot`, `/pdf`, `/evaluate`, `/download`).
+- Write routes that target a tab accept optional `owner`; locked tabs return `423 Locked` unless the owner matches.
+- `/navigate` accepts optional `tabId` and `timeout` (milliseconds).
+- `/recording/export` works after `/recording/stop` for recently completed recordings.
+
+## Library Usage
+
+```typescript
+import { BrowserSession, createServer } from "arise-browser";
+
+// As a library
+const session = BrowserSession.create({ mode: "standalone", headless: true });
+await session.ensureBrowser();
+await session.visit("https://example.com");
+const snapshot = await session.getSnapshot();
+const result = await session.execAction({ type: "click", ref: "e5" });
+
+// As an HTTP server
+const server = await createServer(
+  { mode: "standalone", headless: true },
+  { port: 9867 }
+);
+await server.listen({ port: 9867 });
+```
+
+## Comparison
+
+| Feature | AriseBrowser | Pinchtab |
+|---------|-------------|----------|
+| Headed on servers | Xvfb + Neko WebRTC streaming | Not available |
+| Snapshot format | YAML (~50% fewer tokens) + diff mode | JSON |
+| Persistent refs | 3-layer (WeakMap + aria-ref + signature) | Single pass |
+| Click strategy | Multi-strategy with state validation | Single attempt |
+| Select support | 12 fallback strategies | Empty stub |
+| Behavior recording | Built-in + Learn protocol export | Not available |
+| Multi-agent | Tab locks + session registry | Not available |
+| Coordinate handling | Viewport-validated | Hardcoded (0,0) |
+| Runtime | Node.js + Playwright | Go + CDP |
+| Pinchtab compatible | Yes (accepts `kind` field + `BRIDGE_*` env) | — |
+
+## Works with OpenClaw
+
+AriseBrowser ships with an [OpenClaw skill](skill/arise-browser/SKILL.md) and [plugin](plugin/openclaw.plugin.json). Your OpenClaw agent can discover, install, and use AriseBrowser automatically — no manual setup required.
+
+```bash
+# OpenClaw agents can use AriseBrowser as their browser backend
+# The skill teaches the agent the full API: navigate → snapshot → act → repeat
+# The plugin handles lifecycle: start, health check, stop
+```
+
+## Environment Variables
+
+| Variable | Alias | Default |
+|----------|-------|---------|
+| `ARISE_BROWSER_PORT` | `BRIDGE_PORT` | 9867 |
+| `ARISE_BROWSER_BIND` | `BRIDGE_BIND` | 127.0.0.1 |
+| `ARISE_BROWSER_TOKEN` | `BRIDGE_TOKEN` | (none) |
+| `ARISE_BROWSER_HEADLESS` | — | true |
+| `ARISE_BROWSER_PROFILE` | — | (none) |
+| `ARISE_BROWSER_VIRTUAL_DISPLAY` | — | false |
+| `ARISE_BROWSER_NEKO_PORT` | — | 6090 |
+| `ARISE_BROWSER_NEKO_PASSWORD` | — | neko |
+| `ARISE_BROWSER_NEKO_ADMIN_PASSWORD` | — | admin |
+
+`BRIDGE_*` aliases for Pinchtab drop-in compatibility.
+
+## License
+
+Apache 2.0

package/deploy/neko/CONTEXT.md

@@ -0,0 +1,37 @@
+# deploy/neko/
+
+Configuration files for running arise-browser with Neko streaming on Linux servers.
+
+## Architecture
+
+arise-browser is the single entry process managing all child processes:
+Xvfb (virtual display) -> PulseAudio (virtual audio) -> Openbox (window manager) -> Chrome (CDP) -> Neko (WebRTC streaming)
+
+No supervisord — arise-browser's VirtualDisplayManager handles process lifecycle.
+
+## Files
+
+| File | Source | Purpose |
+|------|--------|---------|
+| `xorg.conf` | neko/runtime/xorg.conf | X11 virtual display with multiple resolution modes |
+| `pulseaudio.pa` | neko/runtime/default.pa | Virtual audio sinks for Neko |
+| `openbox.xml` | neko/apps/google-chrome/openbox.xml | Window manager: no decorations, maximized Chrome |
+| `neko.yaml` | Custom | Neko server defaults (overridden by CLI args via env vars) |
+| `policies.json` | Modified from neko | Chrome policies: CDP enabled, popups allowed |
+| `arise-browser.service` | Custom | systemd unit file |
+| `setup.sh` | Custom | One-shot dependency installer (Debian/Ubuntu + CentOS/RHEL) |
+
+## Port Allocation
+
+| Service | Port | Exposure |
+|---------|------|----------|
+| Neko HTTP/WS | 6090 | Public (user WebRTC) |
+| WebRTC UDP | 52000-52100 | Public (data channel) |
+| arise-browser | 9867 | As needed (AI agent API) |
+| Chrome CDP | 9222 | localhost only |
+
+## Key Differences from Neko Defaults
+
+- `policies.json`: `DeveloperToolsAvailability: 0` (allow CDP), `DefaultPopupsSetting: 1` (allow popups)
+- No forced browser extensions (uBlock Origin, Dark Reader removed)
+- `neko.yaml`: `implicit_hosting: true` (auto-assign host to first user)

package/deploy/neko/arise-browser.service

@@ -0,0 +1,13 @@
+[Unit]
+Description=AriseBrowser with Virtual Display
+After=network.target
+
+[Service]
+Type=simple
+User=neko
+ExecStart=/usr/bin/node /opt/arise-browser/dist/bin/arise-browser.js --virtual-display --port 9867 --host 0.0.0.0
+Restart=always
+RestartSec=5
+
+[Install]
+WantedBy=multi-user.target

package/deploy/neko/neko.yaml

@@ -0,0 +1,12 @@
+desktop:
+  screen: "1920x1080@30"
+
+member:
+  provider: "multiuser"
+  multiuser:
+    admin_password: "admin"
+    user_password: "neko"
+
+session:
+  implicit_hosting: true
+  merciful_reconnect: true