add draft doc#498
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 38e7d33525
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| Download Mirai from [trymirai.com](https://trymirai.com/chat-for-mac), open the DMG, and move Mirai | ||
| to Applications. This also adds the `mirai` CLI to your PATH. |
There was a problem hiding this comment.
Add CLI setup for the DMG install path
For the website/DMG path, dragging Mirai.app into /Applications does not create a shell shim; the Homebrew cask has a separate binary "#{appdir}/Mirai.app/Contents/Resources/cli/mirai" stanza that links the embedded CLI onto PATH. Users who follow these lines and then run mirai in the next section will hit command not found unless they install via the cask or manually symlink/export the embedded CLI.
Useful? React with 👍 / 👎.
| ## From brew | ||
|
|
||
| ```bash | ||
| brew install mirai |
There was a problem hiding this comment.
Use the Homebrew cask install command
Mirai is published as a Homebrew cask, and the upstream cask page lists the install command as brew install --cask mirai (https://formulae.brew.sh/cask/mirai). On a machine without a formula named mirai, this documented command sends users down the formula path and fails or prompts them to rerun with --cask, so the brew installation path should include the cask flag.
Useful? React with 👍 / 👎.
| ```bash | ||
| git clone https://github.com/trymirai/uzu.git | ||
| cd uzu | ||
| cargo tools setup --include-platform-specific |
There was a problem hiding this comment.
Add a Rust prerequisite before cargo setup
This setup step cannot bootstrap a fresh source checkout unless Rust/Cargo is already installed, because .cargo/config.toml defines cargo tools as a Cargo alias that first has to compile and run cli-tools. Users starting from the documented git clone flow on a clean development Mac will fail at cargo: command not found before the helper can install rustup, so the source build path needs an explicit Rust/rustup prerequisite or a non-Cargo bootstrap command.
Useful? React with 👍 / 👎.
| uv init uzu-demo | ||
| cd uzu-demo | ||
| uv add uzu |
There was a problem hiding this comment.
Pin the uv demo to Python 3.12 or newer
The Python package declares requires-python = ">=3.12" in bindings/python/pyproject.toml, while uv init uses the selected/current interpreter to set up the project. On machines where uv defaults to Python 3.11 or older, this sequence leaves the demo project with an incompatible Python requirement and uv add uzu cannot resolve/install the binding; the docs should request a 3.12+ interpreter, e.g. via uv init --python 3.12.
Useful? React with 👍 / 👎.
No description provided.