Skip to content

Getting started

Install Koyd Server where your projects live, then connect the browser or PWA you want to work from.

Install the server

Run the command for your operating system below. The installer detects x64 or ARM64, verifies the signed release, installs Koyd for your user, and sets up https://koyd.internal after system approval. Availability depends on published platform builds.

Windows · PowerShell

Command
irm https://koyd.app/cli/windows | iex

Mac or Linux · Terminal

Command
curl -fsSL https://koyd.app/cli | sh
  1. Copy the Windows command into PowerShell, or the Mac/Linux command into Terminal.
  2. Wait for the verified installation to finish.
  3. Approve the Windows permission prompt, or enter your administrator password on Mac or Linux, to configure the local address automatically.
  4. Open a new terminal and run koyd start --open. You can close the terminal once startup finishes.
  5. Choose Connect instance in the browser window that opens.
Command
koyd doctor
koyd start --open

Good to know · Koyd includes Node.js; no npm or separate Node installation is needed. Install Git for server operations. System approval is needed once for the friendly HTTPS address; the app runs under your regular account. If you cancel, run koyd setup to retry without reinstalling.

Connect a model

  1. Open Settings → Providers in the connected instance.
  2. Choose a supported provider and complete its sign-in flow or enter its API key.
  3. Enable the models you want to use in Settings → Models, then choose one in the session composer.

Provider keys and model execution belong to the selected server. Koyd does not sell model tokens. Provider access, sign-in eligibility, limits, and usage charges follow your own provider account.

Choose a project

  1. Add a project from the project navigation.
  2. Use Koyd’s folder browser to select a directory on the server.
  3. Create a session and give it a focused task.

Good to know · A folder on your phone or client laptop is not automatically a folder on a remote server. Use uploads or your normal repository workflow to move files where the server can reach them.

Send the first prompt

Describe the outcome, relevant files, and how the agent should check its work. Choose a model and mode before sending. You can keep several sessions in the same project and follow their progress independently.

Review the assistant’s response, tool activity, and changed files. Run the relevant checks before committing or shipping. A completed turn is a result to assess, not proof that all work is correct.

Install the app on your devices

Use Install Koyd in the app for instructions appropriate to your browser. Desktop browsers may offer an install action; mobile browsers may use Add to Home Screen. The website download installs the server, while the browser installs the PWA.

Good to know · Some browsers keep separate storage for installed apps. Install first and pair from the installed app if you want to avoid pairing twice. Remote PWA access requires HTTPS.

Connect another device over Wi-Fi

  1. On the server computer, open Manage devices → Connect over Wi-Fi. Select your trusted Wi-Fi or Ethernet connection and choose Enable sharing on this network.
  2. Choose Set up another device. Scan the QR code with a phone or tablet, or open the setup link on another computer on the same network.
  3. Download the certificate from the setup page and follow its device-specific instructions to approve trust once.
  4. Select This device trusts the certificate, then Connect to Koyd. Choose Connect instance in the app.

Good to know · The setup link works once and expires after five minutes. Generate a fresh QR code if it expires during certificate setup. If internet access is unavailable, use Offline setup / manual certificate transfer. Sharing turns off when the server restarts; re-enable it on the server computer. The Server setup guide covers firewall help and address options.

Come back to your work

Open the installed PWA or run koyd open for an already-running instance. Closing the client leaves the server working. Keep the server machine awake; after a reboot, start it again unless you configured your own service manager.

Command
koyd open
koyd instances
koyd status
koyd logs
koyd stop