localimage 0.1.0__py3-none-win_amd64.whl

localimage/__init__.py

@@ -0,0 +1,166 @@
+import json
+import os
+import urllib.error
+import urllib.parse
+import urllib.request
+from dataclasses import dataclass
+from typing import Optional
+
+DEFAULT_ADDR = os.environ.get("LOCALIMAGE_ADDR", "127.0.0.1:7777")
+
+
+@dataclass
+class Session:
+    id: str
+    browser: str
+    protocol: str  # "cdp" (chromium) or "playwright" (firefox)
+    connect_url: str
+    live_url: str  # interactive: can control the browser
+    view_url: str  # read-only: watch only
+    profile: Optional[str]
+    extensions: list
+    expires_at: str
+    _client: "LocalImage"
+
+    def connect(self, playwright):
+        """Attach a Playwright instance (from sync_playwright()) to this session."""
+        if self.protocol == "cdp":
+            return playwright.chromium.connect_over_cdp(self.connect_url)
+        return getattr(playwright, self.browser).connect(self.connect_url)
+
+    def screenshot(self, region: Optional[dict] = None) -> bytes:
+        """PNG of the display; pass {"x", "y", "width", "height"} to crop."""
+        q = ("?" + urllib.parse.urlencode(region)) if region else ""
+        return self._client._raw("GET", f"/v1/sessions/{self.id}/screenshot{q}")
+
+    # Computer controls act on the whole display (screen coordinates), not a page.
+    def _computer(self, action: str, body: dict) -> None:
+        self._client._call("POST", f"/v1/sessions/{self.id}/computer/{action}", body)
+
+    def click(self, x: int, y: int, button: str = "left", num_clicks: int = 1) -> None:
+        self._computer("click", {"x": x, "y": y, "button": button, "num_clicks": num_clicks})
+
+    def move_mouse(self, x: int, y: int) -> None:
+        self._computer("move", {"x": x, "y": y})
+
+    def type(self, text: str, delay_ms: int = 0) -> None:
+        self._computer("type", {"text": text, "delay_ms": delay_ms})
+
+    def press_key(self, *keys: str) -> None:
+        self._computer("key", {"keys": list(keys)})
+
+    def scroll(self, x: int, y: int, delta_x: int = 0, delta_y: int = 0) -> None:
+        self._computer("scroll", {"x": x, "y": y, "delta_x": delta_x, "delta_y": delta_y})
+
+    def drag(self, path: list, button: str = "left") -> None:
+        self._computer("drag", {"path": path, "button": button})
+
+    def start_recording(self) -> dict:
+        """Begin a recording; returns {"replay_id", "status"}. One can run at a time."""
+        return self._client._call("POST", f"/v1/sessions/{self.id}/recording/start")
+
+    def stop_recording(self, replay_id: Optional[str] = None) -> dict:
+        body = {"replay_id": replay_id} if replay_id else None
+        return self._client._call("POST", f"/v1/sessions/{self.id}/recording/stop", body)
+
+    def recordings(self) -> list:
+        return self._client._call("GET", f"/v1/sessions/{self.id}/recordings")
+
+    def download_recording(self, replay_id: Optional[str] = None) -> bytes:
+        """MP4 bytes of a recording; the latest if replay_id is omitted."""
+        path = f"/recordings/{replay_id}" if replay_id else "/recording"
+        return self._client._raw("GET", f"/v1/sessions/{self.id}{path}")
+
+    def exec(self, command: list, cwd: Optional[str] = None, timeout_seconds: int = 0) -> dict:
+        """Run a command in the session container as the browser user (no shell)."""
+        return self._client._call("POST", f"/v1/sessions/{self.id}/process/exec",
+                                  {"command": command, "cwd": cwd or "", "timeout_seconds": timeout_seconds})
+
+    def upload_file(self, path: str, data: bytes) -> dict:
+        q = urllib.parse.urlencode({"path": path})
+        return json.loads(self._client._open("PUT", f"/v1/sessions/{self.id}/files?{q}", data=data))
+
+    def download_file(self, path: str) -> bytes:
+        q = urllib.parse.urlencode({"path": path})
+        return self._client._raw("GET", f"/v1/sessions/{self.id}/files?{q}")
+
+    def list_files(self, path: str) -> list:
+        q = urllib.parse.urlencode({"path": path})
+        return self._client._call("GET", f"/v1/sessions/{self.id}/files/list?{q}")
+
+    def close(self) -> None:
+        self._client.delete(self.id)
+
+    def __enter__(self) -> "Session":
+        return self
+
+    def __exit__(self, *exc) -> None:
+        self.close()
+
+
+class LocalImage:
+    def __init__(self, addr: str = DEFAULT_ADDR, api_key: Optional[str] = None):
+        self.addr = addr
+        self.api_key = api_key or os.environ.get("LOCALIMAGE_API_KEY")
+
+    def _open(self, method: str, path: str, body: Optional[dict] = None,
+              data: Optional[bytes] = None) -> bytes:
+        if data is None and body is not None:
+            data = json.dumps(body).encode()
+        req = urllib.request.Request(
+            f"http://{self.addr}{path}", data=data, method=method,
+            headers={"Content-Type": "application/octet-stream" if body is None and data is not None
+                     else "application/json",
+                     **({"Authorization": f"Bearer {self.api_key}"} if self.api_key else {})},
+        )
+        try:
+            with urllib.request.urlopen(req, timeout=300) as r:
+                return r.read()
+        except urllib.error.HTTPError as e:
+            msg = json.loads(e.read() or b"{}").get("error", f"HTTP {e.code}")
+            raise RuntimeError(msg) from None
+        except urllib.error.URLError as e:
+            raise RuntimeError(
+                f"localimage daemon not reachable at {self.addr}; run `localimage start` ({e.reason})"
+            ) from None
+
+    def _call(self, method: str, path: str, body: Optional[dict] = None):
+        raw = self._open(method, path, body)
+        return json.loads(raw) if raw else None
+
+    def _raw(self, method: str, path: str) -> bytes:
+        return self._open(method, path)
+
+    def create(self, browser: str = "chromium", screen: Optional[str] = None,
+               ttl_seconds: Optional[int] = None, profile: Optional[str] = None,
+               memory_mb: Optional[int] = None, cpus: Optional[float] = None,
+               kiosk: bool = False, extensions: Optional[list] = None) -> Session:
+        s = self._call("POST", "/v1/sessions", {
+            "browser": browser, "screen": screen or "", "ttl_seconds": ttl_seconds or 0,
+            "profile": profile or "", "memory_mb": memory_mb or 0, "cpus": cpus or 0,
+            "kiosk": kiosk, "extensions": extensions or []})
+        return Session(s["id"], s["browser"], s["protocol"], s["connect_url"], s["live_url"],
+                       s["view_url"], s.get("profile"), s.get("extensions") or [], s["expires_at"], self)
+
+    def list(self) -> list:
+        return self._call("GET", "/v1/sessions")
+
+    def upload_extension(self, name: str, zip_bytes: bytes) -> dict:
+        """Upload an unpacked Chromium extension as a zip (manifest.json at the root or in one folder)."""
+        q = urllib.parse.urlencode({"name": name})
+        return json.loads(self._open("POST", f"/v1/extensions?{q}", data=zip_bytes))
+
+    def extensions(self) -> list:
+        return self._call("GET", "/v1/extensions")
+
+    def delete_extension(self, name: str) -> None:
+        self._call("DELETE", f"/v1/extensions/{name}")
+
+    def profiles(self) -> list:
+        return self._call("GET", "/v1/profiles")
+
+    def delete_profile(self, name: str) -> None:
+        self._call("DELETE", f"/v1/profiles/{name}")
+
+    def delete(self, session_id: str) -> None:
+        self._call("DELETE", f"/v1/sessions/{session_id}")

localimage/cli.py

@@ -0,0 +1,17 @@
+import os
+import shutil
+import subprocess
+import sys
+
+
+def main() -> None:
+    """Run the bundled Go binary (shipped in platform wheels) or LOCALIMAGE_BIN."""
+    binary = os.environ.get("LOCALIMAGE_BIN")
+    if not binary:
+        here = os.path.dirname(__file__)
+        exe = "localimage.exe" if sys.platform == "win32" else "localimage"
+        bundled = os.path.join(here, "bin", exe)
+        binary = bundled if os.path.exists(bundled) else shutil.which("localimage")
+    if not binary:
+        sys.exit("localimage: no binary found. Set LOCALIMAGE_BIN to a built binary.")
+    sys.exit(subprocess.call([binary, *sys.argv[1:]]))

localimage-0.1.0.dist-info/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 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 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 those 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

localimage-0.1.0.dist-info/METADATA

@@ -0,0 +1,250 @@
+Metadata-Version: 2.1
+Name: localimage
+Version: 0.1.0
+Summary: Run headful browsers in Docker with live view, locally. CLI + SDK.
+License: Apache-2.0
+Requires-Python: >=3.9
+Project-URL: Homepage, https://github.com/LocalImages/LocalImage
+Project-URL: Source, https://github.com/LocalImages/LocalImage
+Project-URL: Issues, https://github.com/LocalImages/LocalImage/issues
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Testing
+Description-Content-Type: text/markdown
+
+# localimage
+
+Run real, headful browsers in Docker on your own machine — with a live view you can watch and
+control, recordings, and a Playwright-friendly connection URL. Built for end-to-end testing and
+browser agents that need a visible browser, without a hosted service.
+
+- **Chromium and Firefox**, each in its own container with a virtual display
+- **Live view over WebRTC** (smooth video), interactive for you, **read-only** for everyone else
+- **Playwright / Puppeteer** connect over CDP (Chromium) or the Playwright protocol (Firefox)
+- **Recordings** (MP4), **screenshots**, **computer controls** (click, type, scroll, drag),
+  **command exec** and **file upload/download** inside the session
+- **Persistent profiles** and **Chromium extensions**
+- One small daemon, a CLI, and SDKs for **Node** and **Python**
+
+> Built on [Neko](https://github.com/m1k1o/neko) for the virtual display and WebRTC streaming.
+
+## Requirements
+
+- **Docker**, running, and your user allowed to use it (`docker ps` works)
+- Internet access on first use: the browser images are built locally the first time you ask for
+  that browser (about 1 minute for Chromium, a few minutes for Firefox), then cached
+- Node 18+ **or** Python 3.9+ for the SDKs (tested on Node 24 and Python 3.14). The `localimage`
+  binary itself needs neither.
+
+Check your setup any time with `localimage doctor`.
+
+## Install
+
+```bash
+npm install -g localimage        # CLI + Node SDK
+pip install localimage           # CLI + Python SDK
+```
+
+Both ship the same prebuilt `localimage` binary for Linux (x64, arm64), macOS (x64, arm64) and
+Windows (x64). Tested on Linux x64; see [Status](#status).
+
+## Quick start
+
+```bash
+localimage doctor                 # check Docker and the environment
+localimage start                  # run the daemon (leave it running)
+```
+
+In another terminal:
+
+```bash
+localimage create                 # prints the session id and URLs
+```
+
+```jsonc
+{
+  "id": "4a7be405",
+  "browser": "chromium",
+  "protocol": "cdp",
+  "connect_url": "http://127.0.0.1:7777/t/<token>/cdp",   // for Playwright / Puppeteer
+  "live_url":    "http://127.0.0.1:7777/t/<token>/live/?...",  // open in a browser: control it
+  "view_url":    "http://127.0.0.1:7777/v/<token>/?..."        // open in a browser: watch only
+}
+```
+
+Open `live_url`: you see the browser and can use it straight away (it takes control on your first
+click or keypress). Open `view_url` in another tab: same picture, but nothing you do there reaches
+the browser.
+
+### Node
+
+```js
+import { LocalImage } from 'localimage';
+import * as pw from 'playwright-core';
+
+const li = new LocalImage();
+const session = await li.create({ browser: 'chromium' });
+console.log('watch:', session.liveUrl);
+
+const browser = await session.connect(pw);          // connectOverCDP / firefox.connect for you
+const page = browser.contexts()[0].pages()[0] ?? await browser.contexts()[0].newPage();
+await page.goto('https://example.com');
+
+await session.startRecording();
+// ... drive the page ...
+await session.stopRecording();
+const mp4 = await session.downloadRecording();      // Buffer
+
+await browser.close();
+await session.close();                              // removes the container
+```
+
+### Python
+
+```python
+from localimage import LocalImage
+from playwright.sync_api import sync_playwright
+
+with sync_playwright() as pw, LocalImage().create(browser="firefox") as session:
+    print("watch:", session.live_url)
+    browser = session.connect(pw)
+    page = browser.new_page()
+    page.goto("https://example.com")
+    open("shot.png", "wb").write(session.screenshot())
+```
+
+### Firefox needs a matching Playwright
+
+Firefox is driven through Playwright's own server inside the container, so your client's
+`playwright` / `playwright-core` version must match the one in the image, currently **1.63.0**.
+Chromium uses plain CDP and works with any Playwright version.
+
+## Sessions and options
+
+`create` / `LocalImage.create(...)` accept:
+
+| Option | Meaning |
+|---|---|
+| `browser` | `chromium` (default) or `firefox` |
+| `ttl` / `ttlSeconds` | lifetime in seconds; the session is removed after it (default 30 min) |
+| `profile` | named persistent profile (cookies, storage, …). Chromium only. One live session per profile |
+| `extensions` | names of uploaded extensions to load. Chromium only |
+| `kiosk` | Chromium without tabs or address bar |
+| `screen` | display size, e.g. `1440x900@30` (default) |
+| `memoryMb`, `cpus` | resource limits for the container |
+
+Sessions are Docker containers named `localimage-<id>`. They are removed on `close()`, on `rm`, or
+when their TTL expires while the daemon runs.
+
+## Features
+
+- **Recordings:** `startRecording` / `stopRecording`, several per session, one running at a time;
+  list and download each as MP4.
+- **Screenshots:** whole display or a cropped region.
+- **Computer controls:** `click`, `moveMouse`, `type`, `pressKey`, `scroll`, `drag`. These act on
+  the whole display in screen coordinates (not page coordinates) and work for both browsers.
+- **Exec:** run a command inside the session as the browser user (no shell unless you pass
+  `["sh", "-c", ...]`), with a timeout and capped output.
+- **Files:** upload, download and list files inside the session (e.g. the browser's Downloads).
+- **Profiles:** `localimage create --profile work` keeps cookies and storage between sessions.
+- **Extensions:** `localimage extension upload my-ext ./my-ext-dir`, then
+  `localimage create --extension my-ext`.
+
+## CLI
+
+```
+localimage start [-addr host:port]     run the daemon (default 127.0.0.1:7777)
+localimage doctor                      check Docker, images and the daemon
+localimage create [flags]              start a session
+localimage ls | rm <id>                list / delete sessions
+localimage exec <id> -- <cmd...>       run a command in a session
+localimage screenshot <id> [-o file]
+localimage record start|stop|get <id> [-o file]
+localimage profile ls | rm <name>
+localimage extension upload <name> <dir-or-zip> | ls | rm <name>
+```
+
+Run `localimage help` for every flag.
+
+## HTTP API
+
+The daemon exposes a JSON API (default `http://127.0.0.1:7777`):
+
+| | |
+|---|---|
+| `POST/GET /v1/sessions`, `GET/DELETE /v1/sessions/{id}` | create, list, inspect, delete |
+| `POST /v1/sessions/{id}/recording/start`, `.../stop`; `GET .../recording`, `.../recordings[/{rid}]` | recordings |
+| `GET /v1/sessions/{id}/screenshot[?x=&y=&width=&height=]` | PNG |
+| `POST /v1/sessions/{id}/computer/{click,move,type,key,scroll,drag}` | input |
+| `POST /v1/sessions/{id}/process/exec` | run a command |
+| `PUT/GET /v1/sessions/{id}/files?path=`, `GET .../files/list?path=` | file I/O |
+| `POST/GET /v1/extensions`, `DELETE /v1/extensions/{name}` | extensions (zip upload) |
+| `GET /v1/profiles`, `DELETE /v1/profiles/{name}` | profiles |
+| `GET /healthz` | liveness |
+
+## Configuration
+
+| Variable | Default | |
+|---|---|---|
+| `LOCALIMAGE_ADDR` | `127.0.0.1:7777` | daemon address (CLI and SDKs) |
+| `LOCALIMAGE_API_KEY` | unset | if set, the control API requires `Authorization: Bearer <key>` |
+| `LOCALIMAGE_PUBLIC_IP` | `127.0.0.1` | address clients use for WebRTC media (see below) |
+| `LOCALIMAGE_MAX_SESSIONS` | `10` | concurrent sessions allowed |
+| `LOCALIMAGE_MAX_TTL_SECONDS` | `86400` | longest session lifetime allowed |
+
+## Security model
+
+- The daemon listens on **loopback only** by default and **refuses to listen on any other address
+  unless `LOCALIMAGE_API_KEY` is set**.
+- Each session has a random secret in its URLs. `connect_url` and `live_url` give full control of
+  the browser; `view_url` uses a different secret and a viewer login that cannot control anything
+  and cannot reach CDP. **Treat these URLs like passwords.**
+- Anyone with the API key can run commands and read files in your session containers. Sessions are
+  containers, not a hardened sandbox for hostile code.
+- WebRTC video cannot go through the HTTP proxy: each session also opens one media port on the
+  host (the same number inside and outside the container).
+- Sessions are not encrypted on the wire: there is no TLS. Do not expose the daemon to untrusted
+  networks.
+
+## Troubleshooting
+
+- **`localimage doctor`** explains most setup problems.
+- **Black or frozen live view:** a VPN, firewall or browser extension that blocks WebRTC. Try a
+  private window with extensions off, and open the page at `127.0.0.1:7777`.
+- **Remote use:** set `LOCALIMAGE_PUBLIC_IP` to an address the viewer can reach, bind the daemon
+  to a non-loopback address and set `LOCALIMAGE_API_KEY`. This setup is not tested yet.
+- **"profile is already in use":** a Chromium profile can only be open in one session at a time.
+- **Firefox connect fails with a version error:** match Playwright to the image's version.
+
+## Status
+
+Early (0.x). Tested end to end on Linux x64 with Docker: both browsers, live view video and
+control in Chrome, read-only enforcement, recordings, profiles, extensions, exec and files.
+The macOS and Windows builds compile but have not been run. Not implemented: warm browser pools,
+standby/resume, stealth and proxy options, WebKit, TLS, multi-host scaling.
+
+## Development
+
+```bash
+go vet ./... && go test ./...                 # unit tests (Go version: see go.mod)
+go build -o bin/localimage ./cmd/localimage
+
+localimage start &                            # then, in packages/npm:
+npm install && npm test                       # end-to-end tests (needs Docker + network;
+                                              # the live-view test also needs Chrome/Chromium)
+
+python3 scripts/package.py                    # build binaries, npm packages and wheels into dist/
+python3 scripts/bump-version.py 0.2.0         # set the version everywhere
+```
+
+See [RELEASING.md](RELEASING.md) for the release process.
+
+## Acknowledgements
+
+Streaming and the virtual display come from [Neko](https://github.com/m1k1o/neko) (Apache-2.0).
+Firefox automation uses [Playwright](https://playwright.dev) (Apache-2.0). The browser images are
+built locally on your machine from upstream Debian packages and the Neko base images.
+
+## License
+
+[Apache-2.0](LICENSE)

localimage-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+localimage/__init__.py,sha256=uXCghJvzfI9pEFhKHZZ95Qp5NQAe3vxH91V-9cXl45E,7369
+localimage/cli.py,sha256=6mtErpCG-WoGr15JcNBGD8wGuItgS2nLUt04AaqJJ5Q,635
+localimage/bin/localimage.exe,sha256=pyzSTbvNyfpO1XSEaT_UXySQbJwu7eBgfmP0hZ2FQj4,9555456
+localimage-0.1.0.dist-info/METADATA,sha256=a2tLz6thoq-UYSb-ITZSHfdftCjMNSC8YQYWM67Ffp0,10676
+localimage-0.1.0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+localimage-0.1.0.dist-info/WHEEL,sha256=MNa-DEtQPIqhVZKuL7NqnI1k-YYMQ1MICedu76NKZ80,96
+localimage-0.1.0.dist-info/entry_points.txt,sha256=BPMLiDLHFgIqSAHIIER2-ME8OxzS2nh5n770WE6RCGY,51
+localimage-0.1.0.dist-info/RECORD,,

localimage-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: localimage-package
+Root-Is-Purelib: false
+Tag: py3-none-win_amd64

localimage-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+localimage = localimage.cli:main