Oysterun
Menu
繁中 EN

Getting Started

Go from Host readiness to one useful Session.

Follow one phone-first path while keeping the Host identity, browser path, selected folder, and finished response explicit.

Oysterun is Beta software. Provider, operating-system, and Host support depends on the current configuration; this path proves only the choices you verify now and is not a roadmap promise.

  1. Prepare the prerequisites

    On the computer that will own the Host, use a currently supported macOS or Linux environment with Node.js 20 or newer and npm. Decide the exact task-owned nonproduction Host and exact project folder before starting. Stop on a shared or production target, an unexpected Host identity, a browser security warning, or an ambiguous folder.

  2. Install and verify Oysterun

    Install the current public Beta with npm install -g oysterun@latest --prefer-online, then run oysterun --version and record the reported version before setup. Continue only when the command and version are the release you intended to use; do not treat an unpublished build or future date as available product.

  3. Confirm provider readiness

    For the same operating-system user that will run the Host, install and authenticate a provider that the current Host supports. This path uses Codex: open Codex on the Host and confirm it can answer for the exact project folder before involving Oysterun. Stop on a login, trust, model, or readiness warning instead of assuming that every provider or configuration works.

  4. Complete guided Host setup

    Run oysterun, or reopen the wizard with oysterun setup, on the exact task-owned nonproduction Host. Complete the seven guided choices: Host name, Default Browse Root, Host password, Managed connectivity, telemetry and privacy, phone app, and Start Host. If setup offers a restart, first protect live work, verify that exact task Host, and follow its accepted nonproduction task lifecycle. Stop if the target is shared, production, or ambiguous.

  5. Match a fresh QR and Host URL

    Wait until setup reports that the Host started, then compare the Host name and the current URL with the fresh QR shown by that same Host. Treat the QR or bootstrap token like a temporary password: do not publish or save it, do not reuse an old screenshot, and generate a new QR with oysterun show-qr when the old one has expired. A saved URL still requires the current Host sign-in path and current Host password; do not assume an old QR or saved password remains valid.

  6. Open the same Host from phone and browser

    On the phone, scan that fresh QR or enter the exact shown Host URL and current Host password. In an ordinary browser, open the same exact Host URL. The phone and browser are two Clients for one Host identity and the same Session state, not two Hosts. Stop if either Client shows a different Host identity, unexpected address, or security warning.

  7. Enter through the current sign-in path

    Use the Host's current password-only sign-in screen; device pairing and notification permission do not replace Host authentication. The visible success checkpoint is the locale-independent Sessions destination for the Host you just matched. A reachable page proves the route only, not that a provider Session can finish work.

  8. Create one bounded Codex Session

    From Sessions, open a new Session Setup, choose Codex only while its readiness state is current, set a recognizable Agent ID and Session Name, and select the exact Start Folder that will be this Session's Agent Folder. Start the Session, then send this reviewed prompt: Read only the current folder. Reply with the folder name and one sentence describing what it contains. Do not edit, create, delete, move, rename, or execute any file. Stop if the selected provider or folder differs from what you reviewed.

  9. Wait for the completed response

    Connected, a reachable chat, or a Working indicator is not a completed answer. Wait until the working state clears and the provider's final response is visible. The bounded checkpoint is a response that names the selected folder and describes its current contents without asking to change them; a login, approval, tool, or readiness warning and a still-working turn are nonterminal stop states.

  10. Recognize and return to the Session

    Record the Session Name and stable identity shown by Oysterun. Leave the chat, return to Sessions, and open that same row; confirm the same Agent ID, exact folder, and prior response before continuing. This is the return path to the existing Session—do not create a duplicate when the recognized Session is already available.