simdeck 0.1.0 → 0.1.3

package/LICENSE

@@ -1,13 +1,19 @@
-Copyright 2026 Dj
+Copyright OpenJS Foundation and other contributors, https://openjsf.org
 
-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
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-    http://www.apache.org/licenses/LICENSE-2.0
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
-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.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -1,7 +1,23 @@
-# SimDeck
+<p align="center">
+  <img width="180" src="./client/public/simdeck.png">
 
-SimDeck is a developer tool built for streamlining mobile app development for coding agents.
-Drive iOS Simulator apps from the CLI, browser, and automated tests on macOS.
+  <h1 align="center">SimDeck</h1>
+
+  <p align="center">
+    SimDeck is a developer tool built for streamlining mobile app development for coding agents.
+    Drive Simulator from the CLI using agents, browser, and automated tests on macOS.
+  </p>
+</p>
+
+<hr/>
+
+## Try it out
+
+```sh
+npx simdeck
+```
+
+Install the CLI globally for agentic-use:
 
 ```sh
 npm i -g simdeck@latest
@@ -11,25 +27,25 @@ After installing the CLI, install the Codex skill so agents know the stable
 SimDeck workflow:
 
 ```sh
-npx skills add NativeScript/SimDeck --skill simdeck -a codex -g
+npx skills add NativeScript/SimDeck --skill simdeck -g
 ```
 
-For VS Code, install the `nativescript.simdeck` extension to open the simulator
+For VS Code, install the `nativescript.simdeck-vscode` extension to open the simulator
 view inside the editor.
 
 ## Features
 
-- WebTransport streaming server in Rust, plus experimental WebRTC for runner previews, using hardware encoded HEVC/H.264 video
-- Simulator control & inspection using private accessibility APIs
+- Local simulator video stream over browser-native WebRTC H.264
+- Full simulator control & inspection using private accessibility APIs - available using `simdeck` CLI
+- Real-time screen `describe` command using accessibility view tree - available in token-efficient format for agents
 - CoreSimulator chrome asset rendering for device bezels
-- NativeScript and React Native runtime inspector plugins, plus a native UIKit inspector framework for other apps
-- Project daemon reuse: normal CLI commands automatically start and reuse one warm native host per project.
-- Optional macOS LaunchAgent service for an always-on local SimDeck daemon.
+- NativeScript, React Native, UIKit and SwiftUI runtime inspector plugins to view app's view hierarchy live
 - `simdeck/test` for fast JS/TS app tests that can query accessibility state and drive simulator controls.
+- SimDeck Studio for sharing Simulator streams & automatic PR deployments to on-demand simulators
 
 ## Documentation
 
-Full documentation lives at [simdeck.nativescript.org](https://simdeck.nativescript.org/), with guides, the CLI reference, the REST API, the WebTransport video pipeline, and the inspector protocols.
+Full documentation lives at [simdeck.nativescript.org](https://simdeck.nativescript.org/), with guides, the CLI reference, the REST API, the video pipeline, and the inspector protocols.
 
 ## Quick start
 
@@ -37,15 +53,33 @@ Full documentation lives at [simdeck.nativescript.org](https://simdeck.nativescr
 simdeck
 ```
 
-This starts a workspace-local foreground daemon, prints local and LAN browser URLs, and stops when you press Ctrl-C.
+This starts a workspace-local foreground daemon, prints local and LAN HTTP URLs plus a pairing code for LAN browsers, and stops when you press `q` or Ctrl-C.
 To focus a specific simulator by name or UDID, pass it as the only argument:
 
 ```sh
 simdeck "iPhone 17 Pro Max"
 ```
 
-Use `simdeck ui --open` or `simdeck daemon start` when you want a reusable background daemon instead.
-The no-subcommand lifecycle shortcuts are `simdeck -d` for detached start, `simdeck -k` to kill the background daemon, and `simdeck -r` to restart it.
+`simdeck -d` for detached start, `simdeck -k` to kill the background daemon, and `simdeck -r` to restart it.
+
+The served loopback browser UI receives the generated API access token automatically.
+LAN clients should pair with the printed code before receiving the API cookie.
+
+SimDeck Studio providers run the daemon on loopback and use
+`scripts/studio-provider-bridge.mjs` for outbound control-plane communication
+with Studio. Studio hosts the browser UI and proxies SimDeck REST requests over
+that bridge while WebRTC media still negotiates directly between the browser and
+runner through ICE.
+
+Expose a local simulator through SimDeck Studio with one command:
+
+```sh
+simdeck studio expose "iPhone 17 Pro"
+```
+
+The command starts or reuses the local daemon, creates an ephemeral Studio
+session, prints a unique `https://simdeck.djdev.me/simulator/...` URL, and keeps
+the outbound bridge alive until you press Ctrl-C.
 
 CLI commands automatically use the same warm daemon:
 
@@ -55,6 +89,42 @@ simdeck tap <udid> 0.5 0.5 --normalized
 simdeck describe <udid> --format agent --max-depth 2
 ```
 
+## Daemon
+
+Manage the project daemon explicitly when needed:
+
+```sh
+simdeck daemon start
+simdeck daemon restart
+simdeck daemon status
+simdeck daemon stop
+simdeck daemon killall
+```
+
+`simdeck daemon` manages the normal per-project warm process. `daemon killall`
+stops SimDeck daemons across all workspaces.
+
+Use software H.264's low-latency profile on slower runners where freshness is
+more important than full-resolution smoothness:
+
+```sh
+simdeck daemon start --video-codec software --low-latency
+```
+
+Restart the CoreSimulator service layer when `simctl` reports a stale service
+version or the live display gets stuck before the first frame:
+
+```sh
+simdeck core-simulator restart
+```
+
+You can also start or stop the CoreSimulator service layer explicitly:
+
+```sh
+simdeck core-simulator start
+simdeck core-simulator shutdown
+```
+
 ## CLI
 
 ```sh
@@ -70,6 +140,7 @@ simdeck toggle-appearance <udid>
 simdeck pasteboard set <udid> "hello"
 simdeck pasteboard get <udid>
 simdeck screenshot <udid> --output screen.png
+simdeck stream <udid> --frames 120 > stream.h264
 simdeck describe <udid>
 simdeck describe <udid> --format agent --max-depth 4
 simdeck describe <udid> --point 120,240
@@ -87,7 +158,7 @@ simdeck key-combo <udid> --modifiers cmd --key a
 simdeck type <udid> "hello"
 simdeck type <udid> --file message.txt
 simdeck button <udid> lock --duration-ms 1000
-simdeck batch <udid> --step "tap --label Continue" --step "type 'hello'"
+simdeck batch <udid> --step "tap --label Continue" --step "type 'hello'" --step "wait-for --label hello"
 simdeck dismiss-keyboard <udid>
 simdeck home <udid>
 simdeck app-switcher <udid>
@@ -97,6 +168,13 @@ simdeck chrome-profile <udid>
 simdeck logs <udid> --seconds 30 --limit 200
 ```
 
+`boot` prefers SimDeck's private CoreSimulator boot path so it can start devices
+without launching Simulator.app, then falls back to `xcrun simctl` when private
+booting is unavailable.
+
+`stream` writes an Annex B H.264 elementary stream to stdout for diagnostics or
+external tools such as `ffplay`.
+
 `describe` uses the project daemon to prefer React Native, NativeScript, or
 UIKit in-app inspectors, then falls back to the built-in private CoreSimulator
 accessibility bridge. Use `--format agent` or `--format compact-json` for
@@ -104,59 +182,6 @@ lower-token hierarchy dumps. Coordinate commands accept screen coordinates from
 the accessibility tree by default; pass `--normalized` to send `0.0..1.0`
 coordinates directly.
 
-## Daemon
-
-Manage the project daemon explicitly when needed:
-
-```sh
-simdeck daemon start
-simdeck daemon status
-simdeck daemon stop
-```
-
-`simdeck daemon` manages the normal per-project warm process. For an always-on
-daemon that is available after login, use the macOS user service commands:
-
-```sh
-simdeck service on
-simdeck service off
-```
-
-This uses a LaunchAgent, keeps the server bound to localhost by default, and is
-best for agents or editor integrations that should be able to open SimDeck
-without first starting a project daemon.
-
-Use software H.264 when macOS screen recording starves the hardware encoder:
-
-```sh
-simdeck daemon start --video-codec h264-software
-```
-
-For LAN browser access:
-
-```sh
-simdeck ui --bind 0.0.0.0 --advertise-host 192.168.1.50 --open
-```
-
-Restart the CoreSimulator service layer when `simctl` reports a stale service
-version or the live display gets stuck before the first frame:
-
-```sh
-simdeck core-simulator restart
-```
-
-You can also start or stop the CoreSimulator service layer explicitly:
-
-```sh
-simdeck core-simulator start
-simdeck core-simulator shutdown
-```
-
-The daemon exposes HTTP on the requested port and WebTransport on `port + 1`.
-The browser bootstrap comes from `GET /api/health`, which returns the WebTransport URL template,
-certificate hash, and packet version needed by the client.
-The served browser UI receives the generated API access token automatically.
-
 ## JS/TS Tests
 
 ```ts
@@ -216,25 +241,20 @@ React Fiber commits.
 
 ## VS Code
 
-Install the `nativescript.simdeck` extension from the VS Code Marketplace, then
+Install the `nativescript.simdeck-vscode` extension from the VS Code Marketplace, then
 run `SimDeck: Open Simulator View` from the Command Palette. The extension
 opens the simulator inside a VS Code panel and auto-starts the local daemon
 when it is not already reachable.
 
-## SimDeck Cloud
-
-SimDeck Cloud uses the same server binary as its GitHub Actions provider. The
-provider workflow starts `simdeck serve` on the runner, exposes it through a
-tunnel, and lets the hosted control plane connect to the simulator with a
-one-time access token.
-
 ## Contributing
 
 Contributors should read [CONTRIBUTING.md](CONTRIBUTING.md) for local build
 instructions, the dev workflow, and architecture notes.
 
-## License
+## Copyright notice
+
+Copyright [OpenJS Foundation](https://openjsf.org) and `NativeScript` contributors. All rights reserved. The [OpenJS Foundation](https://openjsf.org) has registered trademarks and uses trademarks. For a list of trademarks of the [OpenJS Foundation](https://openjsf.org), please see our [Trademark Policy](https://trademark-policy.openjsf.org/) and [Trademark List](https://trademark-list.openjsf.org/). Trademarks and logos not indicated on the [list of OpenJS Foundation trademarks](https://trademark-list.openjsf.org) are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.
 
-Copyright 2026 Dj
+[The OpenJS Foundation](https://openjsf.org/) | [Terms of Use](https://terms-of-use.openjsf.org/) | [Privacy Policy](https://privacy-policy.openjsf.org/) | [OpenJS Foundation Bylaws](https://bylaws.openjsf.org/) | [Trademark Policy](https://trademark-policy.openjsf.org/) | [Trademark List](https://trademark-list.openjsf.org/) | [Cookie Policy](https://www.linuxfoundation.org/cookies/)
 
-Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE).
+<h3 align="center">Made with ❤️</h3>