Skip to content
KoydDownload free

Getting started

Install Koyd Server on the computer with your projects, connect your browser, add a model provider, and send your first prompt.

Install the server

Install Koyd Server on the computer that holds your projects. The installer detects x64 or ARM64, verifies the signed release, installs Koyd for your user account, and sets up https://koyd.internal:4319 after you approve a system prompt.

Windows · PowerShell

Command
irm https://koyd.app/cli/windows | iex
  1. Paste the command into PowerShell and wait for the verified installation to finish.
  2. Approve the Windows permission prompt. Koyd uses it once to register the local address and trust its HTTPS certificate.
  3. Open a new terminal and run koyd start --open. You can close the terminal once startup finishes.
  4. In the browser window that opens, check the name for this browser and choose Connect instance.
Command
koyd doctor
koyd start --open

Koyd brings its own Node.js runtime, so you don't need npm or a separate Node installation. Install Git on the server. Koyd runs under your regular account; the system prompt only covers the local address. If you cancel it, run koyd setup to retry without reinstalling. On a company computer, see Company computers and networks in Server setup and operations.

Good to know · Mac and Linux installers are coming soon. They use curl -fsSL https://koyd.app/cli | sh in Terminal. Until a build for your system is published, that command explains availability without installing anything. The Download page shows which builds are available.

Connect a model

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

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

Choose a project

  1. Choose Add project (the + next to Projects in the sidebar) to open Add Project.
  2. On the server's own computer, Choose folder opens your system's folder dialog, and Koyd works directly in the folder you pick. Add folders adds more folders to the same project.
  3. From another device, Upload folder copies a folder from that device to the server, and Browse on server picks a folder that is already there.
  4. Create a session in the project and give it a focused task.

Good to know · An uploaded folder is a copy on the server, up to 512 MB and 20,000 files and folders per upload. Agent edits change that copy, not the original on your phone or laptop. Use Git or your usual workflow to bring changes back. If no folder dialog is available on the server, Koyd offers Upload folder and Browse on server instead.

Send the first prompt

Describe the outcome you want, the relevant files, and how the agent should check its work. Choose a model and mode before sending. You can run several sessions in the same project and follow each one separately.

Review the reply, the tool activity, and the changed files. Run the relevant checks before you commit or ship. A finished turn is a result to assess, not proof that the work is correct.

Install the app on your devices

In a browser window, Koyd shows Install Koyd at the top. It opens the install steps for your browser, with an Install app button where the browser supports one. On iPhone and iPad, use Share → Add to Home Screen in Safari. Close the notice with its X if you don't need it right now.

The installed app opens in its own window, and closing it leaves the server running. Desktop browsers that support window-controls overlay give it a compact Koyd title bar. The command on the Download page installs the server; your browser installs the app.

Good to know · Some browsers keep separate storage for installed apps, so the app may ask you to pair again. Install first, then pair from the installed app. Using the app from another device requires an HTTPS address.

Use another device on your network

To open Koyd on a phone, tablet, or another computer on the same Wi-Fi, go to the server computer and open Settings → Instances → Get a browser link. Enable sharing on your network, choose Create setup link, and scan the QR code or open the link on the other device. The setup page walks that device through trusting your server's certificate once.

Good to know · Setup links work once and expire after five minutes. Sharing stops when the server restarts unless you check Keep sharing after restarts and updates. Connect over Wi-Fi in Server setup and operations covers every step, adding a computer to an app you already use, offline setup, and firewall help.

Come back to your work

Open the installed app, go back to https://koyd.internal:4319, or run koyd open. Each device remembers its own selected project and session. Closing the app leaves the server working.

Keep the server computer awake. After a reboot or sign-out, run koyd start again unless you set up your own service. Run koyd help for all commands, or koyd help COMMAND for one of them.

Command
koyd open
koyd status
koyd logs
koyd stop
koyd help