sim-mirror 0.2.0__tar.gz

sim_mirror-0.2.0/.gitignore

@@ -0,0 +1,29 @@
+# Python
+__pycache__/
+*.py[cod]
+.venv/
+/build/
+dist/
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+.coverage.*
+coverage.json
+coverage.xml
+htmlcov/
+
+# Node
+node_modules/
+viewer/dist/
+viewer/coverage/
+*.tgz
+
+# The committed standalone viewer bundle lives in src/sim_mirror/server/static/viewer/ and is not ignored.
+
+# macOS and editors
+.DS_Store
+.idea/
+.vscode/
+*.swp

sim_mirror-0.2.0/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.

sim_mirror-0.2.0/NOTICE

@@ -0,0 +1,14 @@
+SimMirror
+Copyright 2026 Andrew Kochulab
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+
+It includes third-party material under its own licenses; see THIRD_PARTY_LICENSES.md:
+- idb_companion's gRPC protocol definition (facebook/idb), MIT License,
+  Copyright (c) Meta Platforms, Inc. and affiliates.
+- Icon paths from Lucide (lucide.dev), ISC License,
+  Copyright (c) Lucide Contributors 2022; portions Copyright (c) Cole Bemis 2013-2022 (Feather, MIT).
+
+SimMirror is an independent project. It is not affiliated with, endorsed by or sponsored by Apple Inc.,
+Anthropic PBC or Meta Platforms, Inc. iOS, iPhone, Xcode and Simulator are trademarks of Apple Inc.
+Claude and Claude Code are trademarks of Anthropic PBC.

sim_mirror-0.2.0/PKG-INFO

@@ -0,0 +1,210 @@
+Metadata-Version: 2.5
+Name: sim-mirror
+Version: 0.2.0
+Summary: Mirror and drive the iOS Simulator from Claude Code, CLI agents and the browser.
+Project-URL: Homepage, https://github.com/AndrewKochulab/sim-mirror
+Project-URL: Documentation, https://github.com/AndrewKochulab/sim-mirror/tree/main/docs
+Project-URL: Issues, https://github.com/AndrewKochulab/sim-mirror/issues
+Project-URL: Changelog, https://github.com/AndrewKochulab/sim-mirror/blob/main/CHANGELOG.md
+Author: Andrew Kochulab
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+License-File: THIRD_PARTY_LICENSES.md
+Keywords: ai-agents,claude-code,ios-simulator,mcp,screen-mirroring,simulator,ui-automation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: MacOS X
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: fastapi<1,>=0.115
+Requires-Dist: grpclib<0.5,>=0.4.9
+Requires-Dist: protobuf<8,>=7.36
+Requires-Dist: tomli>=2; python_version < '3.11'
+Requires-Dist: tomlkit>=0.13
+Requires-Dist: uvicorn[standard]>=0.35
+Description-Content-Type: text/markdown
+
+<!-- mcp-name: io.github.AndrewKochulab/sim-mirror -->
+
+# SimMirror
+
+**Mirror and drive the iOS Simulator from Claude Code, CLI agents and the browser.**
+
+[![CI](https://github.com/AndrewKochulab/sim-mirror/actions/workflows/ci.yml/badge.svg)](https://github.com/AndrewKochulab/sim-mirror/actions/workflows/ci.yml)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+[![Release](https://img.shields.io/github/v/release/AndrewKochulab/sim-mirror?include_prereleases&sort=semver)](https://github.com/AndrewKochulab/sim-mirror/releases)
+
+![A Claude Code session tapping through Settings on an iPhone 17 Pro simulator in the viewer, its cursor named
+and drawn before each tap](docs/media/hero.gif)
+
+A live iOS Simulator in any browser tab or web page, an animated cursor that shows exactly what your AI agent is about
+to tap, and token-efficient UI snapshots so agents read the screen as compact text instead of screenshots. Works with
+Claude Code, Codex, Cursor and any other MCP client.
+
+> **Status: first public preview (v0.1).** The tools, the viewer and the protocol work today; the embedding API and
+> protocol become stable with v1.0.
+
+## Why SimMirror
+
+- **See the simulator anywhere.** A live H.264 or JPEG stream in a Chrome tab, an iframe or a `<sim-mirror>` web
+  component, with touch, scrolling, typing, hardware buttons and light and dark mode.
+- **Watch what the agent does.** Every agent gesture is announced before it lands, and the viewer's cursor glides to
+  the spot first -- so you can follow along, and step in: an agent waits for your hand to be still.
+- **Spend fewer tokens.** Agents read accessibility snapshots with stable element refs and diffs between screens, act
+  in batches with waits, and reach for a screenshot only when a question is visual.
+
+## Install
+
+**Claude Code**, with the plugin (tools, a skill that teaches snapshot-first use, and `/sim-mirror:open`):
+
+```
+/plugin marketplace add AndrewKochulab/sim-mirror
+/plugin install sim-mirror@sim-mirror
+```
+
+**Any MCP client**, as a stdio server:
+
+```sh
+claude mcp add sim-mirror -- uvx --from git+https://github.com/AndrewKochulab/sim-mirror@v0.2.0 sim-mirror mcp
+```
+
+Configurations for [Codex](docs/clients/codex.md), [Cursor](docs/clients/cursor.md) and
+[other clients](docs/clients/other-mcp.md).
+
+**The command**, for `sim-mirror open`, `doctor` and the rest:
+
+```sh
+uv tool install git+https://github.com/AndrewKochulab/sim-mirror@v0.2.0
+```
+
+**The viewer library**, for your own pages: the npm package `@andrewkochulab/sim-mirror`, attached to each
+[release](https://github.com/AndrewKochulab/sim-mirror/releases). Homebrew and PyPI come with v1.0.
+
+**Requirements:** an Apple Silicon Mac, Xcode 26 or later, [uv](https://docs.astral.sh/uv/), and for touching the
+screen, idb_companion (`brew install facebook/fb/idb-companion`). Details in [Installation](docs/installation.md).
+
+## Quickstart
+
+```sh
+sim-mirror doctor     # check this Mac, ending with a real tap on a simulator
+sim-mirror open       # this project's simulator, live in a browser tab
+```
+
+Then ask your agent:
+
+> Open Settings → General → About and tell me which iOS version this simulator runs. Use sim_snapshot rather than
+> screenshots.
+
+[Getting started](docs/getting-started.md) explains what happens along the way.
+
+## Features
+
+**Live viewer.** H.264 through WebCodecs where the page can decode it, JPEG otherwise, negotiated per connection.
+Touch, drag, scroll, typing and paste, Home and Lock, light and dark, and a device picker. It reconnects by itself
+after a blip and says plainly when the simulator is off.
+
+**Agent cursor.** Every agent gesture -- tap, long press, swipe, drag, typing -- reaches the viewer before it lands, and
+the viewer's own pointer glides there first (`agent.cursor_lead_ms`). Never the Mac's pointer.
+
+**Screen understanding.** A snapshot is a few lines -- `e2 button "General" (201,319)` -- with refs that stay with their
+elements across scrolls, a digest, and diffs. `sim_act` plays up to 20 steps in one call and waits for text, its
+absence, or the screen to settle. See [Screen understanding](docs/screen-understanding.md).
+
+**Connectors.** idb_companion gives full control; without it the simctl connector still mirrors the screen, view-only,
+and says why. More connectors plug in through an entry point. See [Connectors](docs/connectors.md).
+
+**Embedding.** An [iframe](docs/embedding/iframe.md) with a one-shot ticket, the
+[`<sim-mirror>` element](docs/embedding/web-component.md) themed with CSS custom properties, or SimMirror
+[inside a Python application](docs/embedding/python-fastapi.md) with its own sign-in.
+
+**Settings panel.** `sim-mirror open --settings` puts every setting a click away in the viewer, a tab per section,
+saved for one project or all of them and applied before it says so. Settings that decide what runs or who may reach
+the daemon wait for a code from `sim-mirror settings confirm`. See [The settings panel](docs/settings.md).
+
+**Doctor.** Checks Xcode, its Simulator frameworks, runtimes, idb_companion, Device Hub and the desktop session, then
+proves a tap reaches a simulator. See [the doctor](docs/doctor.md).
+
+**Security.** Loopback only, a Host allowlist, exact Origin checks, CORS and framing only for origins you list, hashed
+scoped tokens, and one-shot codes in URL fragments. See [Security](docs/security.md).
+
+**Build and test.** `sim_build_run` and `sim_test` build with xcodebuild for the agent's simulator, install and
+launch, and answer with only what failed and where -- each failing test named so it can be run again alone, and on
+another simulator when asked. Off by default, since they run commands: `sim-mirror config set build.tools true`.
+
+## Measure the token cost
+
+`benchmarks/tool_budget.py` calls each read-only tool through the same MCP relay a client uses and prints each answer's
+bytes, estimated tokens and latency on your own screens; see [the token budget example](examples/token-budget/). On
+an iPhone 17 Pro simulator (iOS 26.5, idb connector) showing Settings → General, 5 calls each (2026-09-16):
+
+| Call | Tool | Bytes | Tokens (est.) | p50 ms | p95 ms |
+|---|---|---:|---:|---:|---:|
+| device info | `sim_device` | 265 | 46 | 2.9 | 3.6 |
+| snapshot, full | `sim_snapshot` | 561 | 112 | 64.8 | 76.4 |
+| snapshot, diff of an unchanged screen | `sim_snapshot` | 83 | 5 | 63.2 | 64.8 |
+| screenshot, 400 px wide | `sim_screenshot` | 62222 | 469 | 8.2 | 8.9 |
+| screenshot, 1200 px wide | `sim_screenshot` | 276472 | 4181 | 20.4 | 21.9 |
+
+Bytes are the whole answer, an image's base64 included; tokens are estimates (text at about 4 characters a token,
+an image at about 750 pixels a token).
+
+## Compatibility
+
+| | Expected to work |
+|---|---|
+| macOS | 26 (15 with Xcode 16.4, view-only) |
+| Xcode | 26 and 27 |
+| Connectors | idb_companion 1.5 (full control), simctl (view-only) |
+| Clients | Claude Code, Codex, Cursor, any stdio MCP client |
+| Browsers | Chrome, Safari, Firefox, Edge |
+
+Rows checked on real hardware are marked verified, with the date, in [Compatibility](docs/compatibility.md).
+
+While SimMirror is `0.x`, the tools, the protocol and the embedding API can still change in a minor release, and the
+changelog says when they do; from 1.0 they are held to [what SimMirror promises not to break](docs/stability.md). Pin
+an exact version either way.
+
+## Documentation
+
+[Everything](docs/README.md): getting started, clients, embedding, screen understanding, connectors, security,
+architecture, and the reference for [tools](docs/reference/tools.md), [configuration](docs/reference/configuration.md),
+the [command line](docs/reference/cli.md) and the [protocol](docs/reference/protocol.md).
+
+## Roadmap
+
+| Milestone | What it brings |
+|---|---|
+| **v0.1** (preview) | Live viewer, agent cursor, person and agent control, MCP tools, `sim-mirror doctor`, idb and simctl connectors, build and test as a preview |
+| **v1.0** | Stable protocol and embedding API, PyPI and npm packages, the MCP registry |
+| **v1.1** | Build, run and test tools become stable |
+| **v1.2** | Richer screen understanding, a native Swift helper, Xcode 27 `mcpbridge` connector, one shared daemon for many hosts |
+| **v2.0** | Real iPhones: view, install and launch without signing; full control through WebDriverAgent |
+| **Android** | Android emulator support with the same viewer, cursor and tools |
+| **Homebrew** | `brew install andrewkochulab/tap/sim-mirror`, right after v1.0 |
+| **Website & launch** | Landing page, video tutorials and guides |
+
+See [ROADMAP.md](ROADMAP.md) and the [milestones](https://github.com/AndrewKochulab/sim-mirror/milestones). How
+SimMirror relates to other tools is in [Comparison](docs/comparison.md).
+
+## Contributing
+
+Contributions are welcome. Read [CONTRIBUTING.md](CONTRIBUTING.md) and the [Code of Conduct](CODE_OF_CONDUCT.md); AI
+coding agents read [AGENTS.md](AGENTS.md). Report security issues privately as described in [SECURITY.md](SECURITY.md).
+Questions go to [Discussions](https://github.com/AndrewKochulab/sim-mirror/discussions).
+
+## License
+
+[Apache-2.0](LICENSE). See [NOTICE](NOTICE) and [THIRD_PARTY_LICENSES.md](THIRD_PARTY_LICENSES.md).
+
+SimMirror is an independent project, not affiliated with Apple or Anthropic. iOS, iPhone, Xcode and Simulator are
+trademarks of Apple Inc.; Claude and Claude Code are trademarks of Anthropic PBC.

sim_mirror-0.2.0/README.md

@@ -0,0 +1,174 @@
+<!-- mcp-name: io.github.AndrewKochulab/sim-mirror -->
+
+# SimMirror
+
+**Mirror and drive the iOS Simulator from Claude Code, CLI agents and the browser.**
+
+[![CI](https://github.com/AndrewKochulab/sim-mirror/actions/workflows/ci.yml/badge.svg)](https://github.com/AndrewKochulab/sim-mirror/actions/workflows/ci.yml)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+[![Release](https://img.shields.io/github/v/release/AndrewKochulab/sim-mirror?include_prereleases&sort=semver)](https://github.com/AndrewKochulab/sim-mirror/releases)
+
+![A Claude Code session tapping through Settings on an iPhone 17 Pro simulator in the viewer, its cursor named
+and drawn before each tap](docs/media/hero.gif)
+
+A live iOS Simulator in any browser tab or web page, an animated cursor that shows exactly what your AI agent is about
+to tap, and token-efficient UI snapshots so agents read the screen as compact text instead of screenshots. Works with
+Claude Code, Codex, Cursor and any other MCP client.
+
+> **Status: first public preview (v0.1).** The tools, the viewer and the protocol work today; the embedding API and
+> protocol become stable with v1.0.
+
+## Why SimMirror
+
+- **See the simulator anywhere.** A live H.264 or JPEG stream in a Chrome tab, an iframe or a `<sim-mirror>` web
+  component, with touch, scrolling, typing, hardware buttons and light and dark mode.
+- **Watch what the agent does.** Every agent gesture is announced before it lands, and the viewer's cursor glides to
+  the spot first -- so you can follow along, and step in: an agent waits for your hand to be still.
+- **Spend fewer tokens.** Agents read accessibility snapshots with stable element refs and diffs between screens, act
+  in batches with waits, and reach for a screenshot only when a question is visual.
+
+## Install
+
+**Claude Code**, with the plugin (tools, a skill that teaches snapshot-first use, and `/sim-mirror:open`):
+
+```
+/plugin marketplace add AndrewKochulab/sim-mirror
+/plugin install sim-mirror@sim-mirror
+```
+
+**Any MCP client**, as a stdio server:
+
+```sh
+claude mcp add sim-mirror -- uvx --from git+https://github.com/AndrewKochulab/sim-mirror@v0.2.0 sim-mirror mcp
+```
+
+Configurations for [Codex](docs/clients/codex.md), [Cursor](docs/clients/cursor.md) and
+[other clients](docs/clients/other-mcp.md).
+
+**The command**, for `sim-mirror open`, `doctor` and the rest:
+
+```sh
+uv tool install git+https://github.com/AndrewKochulab/sim-mirror@v0.2.0
+```
+
+**The viewer library**, for your own pages: the npm package `@andrewkochulab/sim-mirror`, attached to each
+[release](https://github.com/AndrewKochulab/sim-mirror/releases). Homebrew and PyPI come with v1.0.
+
+**Requirements:** an Apple Silicon Mac, Xcode 26 or later, [uv](https://docs.astral.sh/uv/), and for touching the
+screen, idb_companion (`brew install facebook/fb/idb-companion`). Details in [Installation](docs/installation.md).
+
+## Quickstart
+
+```sh
+sim-mirror doctor     # check this Mac, ending with a real tap on a simulator
+sim-mirror open       # this project's simulator, live in a browser tab
+```
+
+Then ask your agent:
+
+> Open Settings → General → About and tell me which iOS version this simulator runs. Use sim_snapshot rather than
+> screenshots.
+
+[Getting started](docs/getting-started.md) explains what happens along the way.
+
+## Features
+
+**Live viewer.** H.264 through WebCodecs where the page can decode it, JPEG otherwise, negotiated per connection.
+Touch, drag, scroll, typing and paste, Home and Lock, light and dark, and a device picker. It reconnects by itself
+after a blip and says plainly when the simulator is off.
+
+**Agent cursor.** Every agent gesture -- tap, long press, swipe, drag, typing -- reaches the viewer before it lands, and
+the viewer's own pointer glides there first (`agent.cursor_lead_ms`). Never the Mac's pointer.
+
+**Screen understanding.** A snapshot is a few lines -- `e2 button "General" (201,319)` -- with refs that stay with their
+elements across scrolls, a digest, and diffs. `sim_act` plays up to 20 steps in one call and waits for text, its
+absence, or the screen to settle. See [Screen understanding](docs/screen-understanding.md).
+
+**Connectors.** idb_companion gives full control; without it the simctl connector still mirrors the screen, view-only,
+and says why. More connectors plug in through an entry point. See [Connectors](docs/connectors.md).
+
+**Embedding.** An [iframe](docs/embedding/iframe.md) with a one-shot ticket, the
+[`<sim-mirror>` element](docs/embedding/web-component.md) themed with CSS custom properties, or SimMirror
+[inside a Python application](docs/embedding/python-fastapi.md) with its own sign-in.
+
+**Settings panel.** `sim-mirror open --settings` puts every setting a click away in the viewer, a tab per section,
+saved for one project or all of them and applied before it says so. Settings that decide what runs or who may reach
+the daemon wait for a code from `sim-mirror settings confirm`. See [The settings panel](docs/settings.md).
+
+**Doctor.** Checks Xcode, its Simulator frameworks, runtimes, idb_companion, Device Hub and the desktop session, then
+proves a tap reaches a simulator. See [the doctor](docs/doctor.md).
+
+**Security.** Loopback only, a Host allowlist, exact Origin checks, CORS and framing only for origins you list, hashed
+scoped tokens, and one-shot codes in URL fragments. See [Security](docs/security.md).
+
+**Build and test.** `sim_build_run` and `sim_test` build with xcodebuild for the agent's simulator, install and
+launch, and answer with only what failed and where -- each failing test named so it can be run again alone, and on
+another simulator when asked. Off by default, since they run commands: `sim-mirror config set build.tools true`.
+
+## Measure the token cost
+
+`benchmarks/tool_budget.py` calls each read-only tool through the same MCP relay a client uses and prints each answer's
+bytes, estimated tokens and latency on your own screens; see [the token budget example](examples/token-budget/). On
+an iPhone 17 Pro simulator (iOS 26.5, idb connector) showing Settings → General, 5 calls each (2026-09-16):
+
+| Call | Tool | Bytes | Tokens (est.) | p50 ms | p95 ms |
+|---|---|---:|---:|---:|---:|
+| device info | `sim_device` | 265 | 46 | 2.9 | 3.6 |
+| snapshot, full | `sim_snapshot` | 561 | 112 | 64.8 | 76.4 |
+| snapshot, diff of an unchanged screen | `sim_snapshot` | 83 | 5 | 63.2 | 64.8 |
+| screenshot, 400 px wide | `sim_screenshot` | 62222 | 469 | 8.2 | 8.9 |
+| screenshot, 1200 px wide | `sim_screenshot` | 276472 | 4181 | 20.4 | 21.9 |
+
+Bytes are the whole answer, an image's base64 included; tokens are estimates (text at about 4 characters a token,
+an image at about 750 pixels a token).
+
+## Compatibility
+
+| | Expected to work |
+|---|---|
+| macOS | 26 (15 with Xcode 16.4, view-only) |
+| Xcode | 26 and 27 |
+| Connectors | idb_companion 1.5 (full control), simctl (view-only) |
+| Clients | Claude Code, Codex, Cursor, any stdio MCP client |
+| Browsers | Chrome, Safari, Firefox, Edge |
+
+Rows checked on real hardware are marked verified, with the date, in [Compatibility](docs/compatibility.md).
+
+While SimMirror is `0.x`, the tools, the protocol and the embedding API can still change in a minor release, and the
+changelog says when they do; from 1.0 they are held to [what SimMirror promises not to break](docs/stability.md). Pin
+an exact version either way.
+
+## Documentation
+
+[Everything](docs/README.md): getting started, clients, embedding, screen understanding, connectors, security,
+architecture, and the reference for [tools](docs/reference/tools.md), [configuration](docs/reference/configuration.md),
+the [command line](docs/reference/cli.md) and the [protocol](docs/reference/protocol.md).
+
+## Roadmap
+
+| Milestone | What it brings |
+|---|---|
+| **v0.1** (preview) | Live viewer, agent cursor, person and agent control, MCP tools, `sim-mirror doctor`, idb and simctl connectors, build and test as a preview |
+| **v1.0** | Stable protocol and embedding API, PyPI and npm packages, the MCP registry |
+| **v1.1** | Build, run and test tools become stable |
+| **v1.2** | Richer screen understanding, a native Swift helper, Xcode 27 `mcpbridge` connector, one shared daemon for many hosts |
+| **v2.0** | Real iPhones: view, install and launch without signing; full control through WebDriverAgent |
+| **Android** | Android emulator support with the same viewer, cursor and tools |
+| **Homebrew** | `brew install andrewkochulab/tap/sim-mirror`, right after v1.0 |
+| **Website & launch** | Landing page, video tutorials and guides |
+
+See [ROADMAP.md](ROADMAP.md) and the [milestones](https://github.com/AndrewKochulab/sim-mirror/milestones). How
+SimMirror relates to other tools is in [Comparison](docs/comparison.md).
+
+## Contributing
+
+Contributions are welcome. Read [CONTRIBUTING.md](CONTRIBUTING.md) and the [Code of Conduct](CODE_OF_CONDUCT.md); AI
+coding agents read [AGENTS.md](AGENTS.md). Report security issues privately as described in [SECURITY.md](SECURITY.md).
+Questions go to [Discussions](https://github.com/AndrewKochulab/sim-mirror/discussions).
+
+## License
+
+[Apache-2.0](LICENSE). See [NOTICE](NOTICE) and [THIRD_PARTY_LICENSES.md](THIRD_PARTY_LICENSES.md).
+
+SimMirror is an independent project, not affiliated with Apple or Anthropic. iOS, iPhone, Xcode and Simulator are
+trademarks of Apple Inc.; Claude and Claude Code are trademarks of Anthropic PBC.