Skip to main content
Complete the terminal quickstart first. You need Node.js 22+ for the spatial workspace. Run these commands from the application checkout, not the documentation repository.
1

Install and build the spatial workspace

2

Pair your Entity and shell

Replace rook with your Entity’s config identifier. The wizard connects an Entity bridge, human identity, and shell. Its default shell path is ngramAR/shells/<entity>.To select a specific existing shell:
Follow the generated instructions and keep the canonical Entity process running. Shell configuration does not itself run the Python Entity.
3

Start the browser surface

Open the local URL printed by the command, normally http://localhost:3000.
4

Try a spatial action

Ask the Entity:
Inspect your current surface, wave hello, then place a small periwinkle cube in front of us.
Confirm the inspection describes your actual session, the gesture plays, and a geometric cube appears. The expected tools are ar_inspect_surface, ar_gesture, and ar_spawn_object.

Share an existing relationship

If you already talk to the Entity in Telegram, send /whoami there. Use the returned person identifier when pairing AR:
Replace the bracketed value with your own identifier and keep it in local configuration. Do not publish real user IDs in examples or shared shell files.

Enter a headset session

For a supported headset on a trusted LAN, the integrated Quest lab workflow handles hosted inference checks and the HTTPS spatial surface:
For a manual setup, the spatial CLI supports a LAN host:
Use the printed HTTPS network URL on the headset. A localhost URL on the headset refers to the headset itself, not your development computer.

Stop and resume

Use the surface’s stop control or a direct “stop” request to cancel the active spatial turn. Closing a tab disconnects that surface; it does not stop a separate Entity worker. Use Ctrl+C for a foreground launcher, and see runtime stop controls for unattended processes.