// readme

Ork

Ork is a source-available assistant for persistent bots that share conversations and work on isolated computers, with a web app, API, worker, Tauri client, and Expo client in one repository. Its public domain is orkbot.run. Use orkbot in package names and technical identifiers.

Run locally

Install Node.js 22.22.2+ within the 22.x line, Node.js 24, or Node.js 26+, and start Docker. The repository pins pnpm 9.15.0 through Corepack.

corepack pnpm install --frozen-lockfile
corepack pnpm setup:local
corepack pnpm db:up
corepack pnpm dev

Before starting the API, set the registered Accounts public client ID in .env as OIDC_CLIENT_ID. The local callback is http://127.0.0.1/callback, with the development port supplied at runtime. See Accounts sign-in.

Open the development URL printed after migrations finish, usually http://127.0.0.1:5173. Continue through Ork Accounts to sign in. No model key is needed to open the app.

setup:local creates .env with random database passwords and independent encryption, authentication, supervisor, and screen-proxy secrets.โ€ฆ