Skip to content

Every Yui has a repo: point to the platform repos #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CJohnDesign wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Every Yui has a repo: point to the platform repos #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Notes for AI coding agents working in this repo.

- **Contributing?** Read [CONTRIBUTING-AGENTS.md](CONTRIBUTING-AGENTS.md) first. Take one open card from https://www.yuigui.com/contribute/backlog.json, claim it with a draft pull request titled `[KEY] ...`, and follow the card's tests.
- What this repo is: the Yui iPhone app (SwiftUI, XcodeGen `project.yml`), the Swift Yui Lines parser (`Packages/YuiLines`), the Supabase backend (`supabase/`) and the Hermes plugin (`hermes-plugin/`). The spec, roadmap and site live in [postscarcityai/yuigui](https://github.com/postscarcityai/yuigui).
- What this repo is: the Yui iPhone app (SwiftUI, XcodeGen `project.yml`), the Swift Yui Lines parser (`Packages/YuiLines`), the Supabase backend (`supabase/`) and the Hermes plugin (`hermes-plugin/`). The spec, roadmap and site live in [postscarcityai/yuigui](https://github.com/postscarcityai/yuigui). Every other platform has its own repo (`yui-macos`, `yui-watch`, `yui-visionos`, `yui-tvos`, `yui-android`, `yui-wearos`, `yui-desktop`, `yui-omarchy`, `yui-web`; README, "Every Yui"). The Apple ones use this repo as a submodule, so a shared-code change here must keep the iPhone app building and behaving exactly as before.
- Tests: `cd Packages/YuiLines && swift test`, then `xcodegen generate` and `xcodebuild test -scheme Yui -destination 'platform=iOS Simulator,name=<any iPhone simulator>' -only-testing:YuiTests`.
- Never commit keys, team ids, certificates or personal data. Never touch `.github/`, signing, TestFlight or release scripts.
- Style: plain words in the UI, no em dashes, no developer tooling in what a person sees.
2 changes: 2 additions & 0 deletions CONTRIBUTING-AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Want your agent to do this every week on its own? The routine prompts for Claude

Everything in [CONTRIBUTING.md](CONTRIBUTING.md) applies too.

A card for the Mac, a watch, Android or another platform names its own repo (`yui-macos`, `yui-android` and the rest; README, "Every Yui"): fork that one, not this. When a platform card needs a change in the shared Swift here, that change is its own small pull request to this repo, and the iPhone tests below must still pass.

## Never touch

- Keys, tokens, team ids, certificates, provisioning profiles or anyone's personal data. `DEVELOPMENT_TEAM` stays `${YUI_TEAM_ID}` in `project.yml`: set your own team in your shell, or use Sign to Run Locally.
Expand Down
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Yui is a phone app for talking to your own AI agents. You chat like normal. When

Yui brings no brain of its own. You bring the agent, and Yui gives it a face, a voice and a screen it can draw on. Hermes is the first agent it supports.

This repo holds the native SwiftUI app, the Swift Yui Lines parser, the Supabase backend and the Hermes plugin. The roadmap, the progress log and the Yui Lines spec live in the hub repo, [postscarcityai/yuigui](https://github.com/postscarcityai/yuigui), and at [yuigui.com](https://www.yuigui.com).
This repo holds the native SwiftUI app, the Swift Yui Lines parser, the Supabase backend and the Hermes plugin. The roadmap, the progress log and the Yui Lines spec live in the hub repo, [postscarcityai/yuigui](https://github.com/postscarcityai/yuigui), and at [yuigui.com](https://www.yuigui.com). Every other platform has its own repo: see [Every Yui](#every-yui).

<p>
<img src="docs/img/app-chat.png" width="260" alt="Yui chat screen on iPhone">
Expand Down Expand Up @@ -159,6 +159,24 @@ scripts/devbuild.sh --no-send # build and host, print the link, send nothing

**App Review demo.** Apple's reviewer taps **Demo code** on the sign-in screen and enters the code from the review notes (App Store Connect only, never in this repo). `yui-auth` grant `review` checks it against the edge secret `YUI_REVIEW_CODE` and opens the one account `YUI_REVIEW_USER`; with either secret unset the grant is off. That account's agent is `hermes-plugin/demo_agent.py`: a scripted agent with canned Yui Lines screens, no model and no tools, on its own connector token (`~/.hermes/yui/demo-connector.json`), kept up by launchd. If the reviewer deletes the account, the next demo sign-in recreates it and the demo agent pairs itself again. Gate: `python3 supabase/tests/review_test.py` (21 checks). The App Privacy answers live in `docs/APP-PRIVACY.md`.

## Every Yui

This repo is the iPhone and iPad app. Every other platform has a repo of its own on postscarcityai, so whoever builds it has a place to push. Each keeps the same contract: it speaks Yui Lines and passes the shared conformance vectors, a tap sends the same line the iPhone sends, and a screen the device cannot draw says "Open on your iPhone" (or phone) instead of breaking.

| Platform | Repo | Built with |
| --- | --- | --- |
| Mac | [yui-macos](https://github.com/postscarcityai/yui-macos) | SwiftUI for macOS |
| Apple Watch | [yui-watch](https://github.com/postscarcityai/yui-watch) | SwiftUI for watchOS |
| Apple Vision Pro | [yui-visionos](https://github.com/postscarcityai/yui-visionos) | SwiftUI for visionOS |
| Apple TV | [yui-tvos](https://github.com/postscarcityai/yui-tvos) | SwiftUI for tvOS |
| Android phones and tablets | [yui-android](https://github.com/postscarcityai/yui-android) | Kotlin and Jetpack Compose |
| Wear OS | [yui-wearos](https://github.com/postscarcityai/yui-wearos) | Kotlin and Compose for Wear OS |
| Windows and Linux | [yui-desktop](https://github.com/postscarcityai/yui-desktop) | Tauri 2 and the web renderer |
| Omarchy | [yui-omarchy](https://github.com/postscarcityai/yui-omarchy) | Rust in the terminal, in your Omarchy theme |
| Browser | [yui-web](https://github.com/postscarcityai/yui-web) | The web renderer, live on the relay |

The Apple repos pull this one in as a git submodule at `yui/`, for `Packages/YuiLines` and any shared file that compiles on their platform. They never copy or edit it: a change the shared code needs (an `#if os(iOS)` guard, a small shim) comes here as its own pull request, and the iPhone app must build and behave exactly as before. The first pull request for each platform is a card on [yuigui.com/contribute](https://www.yuigui.com/contribute#platforms).

## Contributing

Issues and pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) and the [Code of Conduct](CODE_OF_CONDUCT.md). Found a security problem? Please read [SECURITY.md](SECURITY.md) first.
Expand Down
Loading