Repository navigation
docs: add AGENTS.md with a prompt to get the viewer running - #13
Merged
Merged
Conversation
Coding agents need a pasteable prompt that launches the published viewer without a checkout or Rust toolchain.
AGENTS.md is the conventional agent entry point and keeps the commands, platform matrix, and desktop-session constraint in one place. The README links to it from a collapsed block, matching the existing pip and from-source blocks, so the human quick start stays first.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
AGENTS.mdas the canonical entry point for coding agents asked to run or integrate Hyper: theuvxlaunch commands, accepted inputs, the Python API path, and the in-checkout commands.Why this shape
The first commit put an expanded
### For agentssection above the human quick start. That introduced the onlyh3in a README that is otherwise allh2plus<details>blocks, and it restated theuvxcommand and wheel matrix that appear ~10 lines below — two places to update whenever either changes.AGENTS.mdis the conventional file agents look for and holds the detail once. The README block is collapsed like the existing Use pip instead of uv and Run from source blocks, so the one-line human command stays the first thing under the heading.AGENTS.mdalso records the constraint agents most often get wrong: the viewer opens a native window on the machine running the command, so a remote host or container cannot display on the user's laptop.Verification
cargo run --locked -p hyper-viz --example project_scene— passes, no windowcargo run --locked -- --help— exits cleanly with no window; confirms--helpis headless-safe as documented.Args::parse()precedes all window setup insrc/main.rsAGENTS.mdresolveh3, three consistent<details>blocksuvxpath and the GUI itself