agent-web-os 0.1.19 → 0.2.1

package/README.md

@@ -2,79 +2,66 @@
 
 **[English](./README.md)** | **[中文](./README.zh-CN.md)**
 
-Browser-based operating system for your agents. Bash + Node.js + Python runtime with an observable in-memory filesystem. Install NPM or PIP packages, run shell commands, execute Node.js scripts, and manage files entirely in the browser — no server required. Supports Claude Code, Codex CLI, and OpenCode.
+A browser-based operating system for AI agents. Full Bash shell, Node.js runtime, and Python 3.11 execution. Observable in-memory filesystem. No server required.
 
 ## Install
 
 ```bash
 npm install agent-web-os
+bun add agent-web-os
+pnpm add agent-web-os
+yarn add agent-web-os
 ```
 
-## Usage
+## Vite Integration
 
-### Bash Session
-
-Create a full bash session with a virtual filesystem, shell, and Node.js runtime:
+Install `agent-web-os`, create a session in the browser, and execute commands from your component or hook.
 
 ```ts
-import { createBrowserBashSession } from "agent-web-os"
-
-const session = createBrowserBashSession({
-  rootPath: "/workspace",
-})
+import { createBrowserBashSession, executeBrowserBash } from "agent-web-os"
 
-// Run shell commands
-const result = await executeBrowserBash(session, "echo hello world")
-console.log(result.stdout) // "hello world\n"
+const session = createBrowserBashSession({ rootPath: "/workspace" })
 
-// Read/write files through the observable filesystem
-session.fs.writeFileSync("/workspace/index.js", 'console.log("hi")')
-await executeBrowserBash(session, "node index.js")
-
-// Clean up
-session.dispose()
+export async function runAgentWebOsDemo() {
+    const result = await executeBrowserBash(session, "node --version")
+    console.log(result.stdout)
+}
 ```
 
-### Observable Filesystem
-
-A reactive in-memory filesystem that emits change events:
+## xterm Integration
 
-```ts
-import { ObservableInMemoryFs } from "agent-web-os"
-
-const fs = new ObservableInMemoryFs()
-
-fs.subscribe((event) => {
-  console.log(event.event, event.path) // "add", "/hello.txt"
-})
+Install xterm separately, attach it to your DOM node, mirror stdout into the terminal, and send keystrokes into `writeStdin` for interactive tools.
 
-fs.writeFileSync("/hello.txt", "world")
+```bash
+npm install @xterm/xterm @xterm/addon-fit
+bun add @xterm/xterm @xterm/addon-fit
+pnpm add @xterm/xterm @xterm/addon-fit
+yarn add @xterm/xterm @xterm/addon-fit
 ```
 
-### Node.js Runtime
-
-Run Node.js scripts and npm commands in the browser via [almostnode](https://www.npmjs.com/package/almostnode):
-
 ```ts
-import { createAlmostNodeSession } from "agent-web-os"
-
-const nodeSession = createAlmostNodeSession(fs)
-// Provides node, npm install, npm run, and Vite dev server support
-```
+import { Terminal } from "@xterm/xterm"
+import { FitAddon } from "@xterm/addon-fit"
+import "@xterm/xterm/css/xterm.css"
+import { createBrowserBashSession, executeBrowserBash } from "agent-web-os"
 
-### Service Worker Bridge
+const session = createBrowserBashSession({ rootPath: "/workspace" })
+const terminal = new Terminal({ convertEol: true, cursorBlink: true })
+const fitAddon = new FitAddon()
 
-For HTTP server support within the browser, register the service worker:
+terminal.loadAddon(fitAddon)
+terminal.open(container)
+fitAddon.fit()
 
-```ts
-import { getServerBridge } from "agent-web-os"
+void executeBrowserBash(session, "python --version")
+session.setStdoutWriter((data) => terminal.write(data))
+session.setTerminalSize(terminal.cols, terminal.rows)
 
-const bridge = getServerBridge()
-await bridge.initServiceWorker()
+terminal.onData((data) => {
+    session.writeStdin(data)
+})
 ```
 
-Copy `node_modules/agent-web-os/dist/__sw__.js` to your public directory so the service worker can be registered.
-
 ## License
 
 MIT

package/README.zh-CN.md

@@ -2,79 +2,66 @@
 
 **[English](./README.md)** | **[中文](./README.zh-CN.md)**
 
-基于浏览器的 Agent 操作系统。集成 Bash + Node.js + Python 运行时，内置可观测的内存文件系统。支持安装 NPM 或 PIP 包、执行 Shell 命令、运行 Node.js 脚本，并在浏览器中管理文件——无需服务器。兼容 Claude Code、Codex CLI 和 OpenCode。
+基于浏览器的 AI Agent 操作系统。完整的 Bash Shell、Node.js 运行时和 Python 3.11 执行环境。可观测的内存文件系统。无需服务器。
 
 ## 安装
 
 ```bash
 npm install agent-web-os
+bun add agent-web-os
+pnpm add agent-web-os
+yarn add agent-web-os
 ```
 
-## 使用方法
+## Vite 集成
 
-### Bash 会话
-
-创建一个完整的 Bash 会话，包含虚拟文件系统、Shell 和 Node.js 运行时：
+安装 `agent-web-os`，在浏览器中创建会话，然后从组件或 Hook 中执行命令。
 
 ```ts
-import { createBrowserBashSession } from "agent-web-os"
-
-const session = createBrowserBashSession({
-  rootPath: "/workspace",
-})
+import { createBrowserBashSession, executeBrowserBash } from "agent-web-os"
 
-// 执行 Shell 命令
-const result = await executeBrowserBash(session, "echo hello world")
-console.log(result.stdout) // "hello world\n"
+const session = createBrowserBashSession({ rootPath: "/workspace" })
 
-// 通过可观测文件系统读写文件
-session.fs.writeFileSync("/workspace/index.js", 'console.log("hi")')
-await executeBrowserBash(session, "node index.js")
-
-// 清理资源
-session.dispose()
+export async function runAgentWebOsDemo() {
+    const result = await executeBrowserBash(session, "node --version")
+    console.log(result.stdout)
+}
 ```
 
-### 可观测文件系统
-
-响应式的内存文件系统，支持变更事件监听：
+## xterm 集成
 
-```ts
-import { ObservableInMemoryFs } from "agent-web-os"
-
-const fs = new ObservableInMemoryFs()
-
-fs.subscribe((event) => {
-  console.log(event.event, event.path) // "add", "/hello.txt"
-})
+单独安装 xterm，将其挂载到 DOM 节点，将 stdout 映射到终端，并将按键输入发送到 `writeStdin` 以支持交互式工具。
 
-fs.writeFileSync("/hello.txt", "world")
+```bash
+npm install @xterm/xterm @xterm/addon-fit
+bun add @xterm/xterm @xterm/addon-fit
+pnpm add @xterm/xterm @xterm/addon-fit
+yarn add @xterm/xterm @xterm/addon-fit
 ```
 
-### Node.js 运行时
-
-通过 [almostnode](https://www.npmjs.com/package/almostnode) 在浏览器中运行 Node.js 脚本和 npm 命令：
-
 ```ts
-import { createAlmostNodeSession } from "agent-web-os"
-
-const nodeSession = createAlmostNodeSession(fs)
-// 支持 node、npm install、npm run 和 Vite 开发服务器
-```
+import { Terminal } from "@xterm/xterm"
+import { FitAddon } from "@xterm/addon-fit"
+import "@xterm/xterm/css/xterm.css"
+import { createBrowserBashSession, executeBrowserBash } from "agent-web-os"
 
-### Service Worker 桥接
+const session = createBrowserBashSession({ rootPath: "/workspace" })
+const terminal = new Terminal({ convertEol: true, cursorBlink: true })
+const fitAddon = new FitAddon()
 
-如需在浏览器中支持 HTTP 服务器，注册 Service Worker：
+terminal.loadAddon(fitAddon)
+terminal.open(container)
+fitAddon.fit()
 
-```ts
-import { getServerBridge } from "agent-web-os"
+void executeBrowserBash(session, "python --version")
+session.setStdoutWriter((data) => terminal.write(data))
+session.setTerminalSize(terminal.cols, terminal.rows)
 
-const bridge = getServerBridge()
-await bridge.initServiceWorker()
+terminal.onData((data) => {
+    session.writeStdin(data)
+})
 ```
 
-将 `node_modules/agent-web-os/dist/__sw__.js` 复制到你的 public 目录，以便注册 Service Worker。
-
 ## 许可证
 
 MIT