Documentation

Build with Qorvyn, from first sign-in to SDK

A practical guide to activating a device, initializing projects, using Qorvyn safely and connecting your own tools through the TypeScript SDK, MCP or the CLI.

User guide

Quickstart

Qorvyn is proprietary software that is free to use with a free account. It is published on npm; the source is not public. Node.js 22.13+, Git and internet access are required (Qorvyn checks your account online before protected commands).

repository root
# in a JavaScript/TypeScript project (or: npm install -g qorvyn for any repository)
npm install --save-dev qorvyn
npx qorvyn activate
npx qorvyn init
npx qorvyn status
npx qorvyn dashboard
  1. Activate this device. Open the displayed sign-in URL and use Microsoft or verified email. Never share the device code.
  2. Initialize the repository. Qorvyn creates private state under ~/.qorvyn, detects the project and builds its local index. It never joins a team on its own: to share the project with your team, run qorvyn team link.
  3. Optional: let your agent tailor the setup. qorvyn init --ai (or qorvyn setup --ai later) asks Claude Code or Codex to read the project and propose agents made for it; everything it proposes is marked for your review.
  4. Review before running. Inspect generated agents, workflows, guardrails and every proposed plan or diff.

Daily use

qorvyn context search "query"Search local code with file and line citations.
qorvyn indexRefresh the index after large repository changes.
qorvyn do "goal"Plan, implement, review and test through guarded agents.
qorvyn dashboardOpen the local visual workspace: every project on this computer in one dashboard, with a project switcher. Group repositories that ship together into a product, with shared workflows and goals across them. Add runners (other computers that take work) on the Runners page.
qorvyn features on <name>Switch on Engineering Foundation features (qorvyn features lists them); everything else works as before.
qorvyn docs add <file>Add documents (PDF, Markdown, text) as cited knowledge; qorvyn kb and qorvyn lessons review what runs learned.
qorvyn product create <name>Start a product from an idea: spec, approvals, impact and state against code, CI and deployments.
qorvyn checks preset secretsChecks Qorvyn runs itself as evidence; qorvyn release readiness is ready only on evidence.
qorvyn workflows forecast <id>The AI cost of a workflow before it runs, with budgets per run.
qorvyn env plan --referencePriced Azure environments you approve; deploy --canary rolls back on failed health checks.
qorvyn env pool plan <env> <pool>Enterprise: a pool of runners in your own Azure (Container Apps, its own identity and Key Vault), through approved plans.
qorvyn backlogThe prioritized backlog; start <id> --workflow w runs a workflow with an item.
qorvyn defects · qorvyn testsDefects verified only with evidence, and manual tests per commit; both count in release readiness.
qorvyn report --days 7A progress report for your client, as Markdown.
qorvyn roles set quality you@company.comPlan roles: who approves which steps and deliveries.
qorvyn mcpExpose cited project context to an MCP-compatible tool.
qorvyn helpSee commands available in your installed version.

Free and Enterprise access

The service is authoritative. Your plan, project slots, account state, device state, organization membership and minimum supported versions are evaluated online using server time.
  • Every account starts on the Free plan: it does not expire and includes up to three personal projects. A project is one product, not a folder or a clone: the same repository on a second computer uses the project it already has. Qorvyn sends only a hash of the repository address, never a path.
  • One sign-in covers your personal account and every organization you belong to, each with its own role and its own project allowance (qorvyn account shows them). Belonging to an organization never changes your personal allowance, and an organization's projects never use your personal projects.
  • Organization projects are authorized separately and never consume personal project slots; an organization's allowance is set in its own agreement.
  • A blocked personal account can still use an active Enterprise project. A disabled account blocks every scope.
  • Protected operations require a short-lived, project-bound authorization. There is no offline grace period.
  • Activation, help, version, entitlement status, export and uninstall remain available for recovery.
SDK configuration

Start the local runtime once

All non-TypeScript SDKs use the same loopback-only OpenAPI contract. Start the runtime inside the initialized project, then pass the printed metadata-file path to your application.

terminal
npx qorvyn serve
export QORVYN_RUNTIME_FILE="/path/printed/by/qorvyn/runtime.json"
Treat runtime.json as a secret. It contains the local port and bearer token, is mode 0600, belongs to one project/runtime and must never be committed, uploaded or logged. SDKs intentionally connect only to 127.0.0.1.
Official clients

Choose your SDK

The TypeScript SDK ships in the npm package: import { connect } from "qorvyn". Other languages are coming; until then any language can use the CLI's --json output or MCP.

TS / JSPython UpcomingGo UpcomingDart / Flutter Upcoming.NET / C# UpcomingJava UpcomingKotlin UpcomingSwift UpcomingRust Upcoming
TypeScript / JavaScriptNode.js 22.13+

Use the SDK exported by the qorvyn npm package. auto prefers a runtime and falls back to direct local access; use runtime to require qorvyn serve.

import { connect } from "qorvyn";
const q = await connect({ root: process.cwd(), mode: "auto" });
const hits = await q.context.search("authentication", { limit: 10, path: "src/" });
console.log(hits);
q.close();

One consistent API surface

OperationPurpose
healthCheck runtime readiness.
get projectRead project status and profile.
searchSearch context with file, line and commit citations.
read fileRead a bounded repository-relative file range.
find symbolFind indexed definitions and symbols.
refresh indexRun an incremental or full index refresh.
memoryList, add and remove local project knowledge.
sync statusInspect team synchronization state.

Security rules

  • Never put a runtime token, device key or provider key in source control, logs, crash reports or support tickets.
  • Do not proxy the runtime onto a LAN or public address. It is designed for same-machine processes.
  • Do not infer Free or Enterprise access in client code. The FACTn service is authoritative.
  • Authorization traffic contains identifiers and signed claims—not code, prompts, repository addresses, indexes, secrets or outputs.

Troubleshooting

ErrorResolution
NO_RUNTIMEStart qorvyn serve in this repository and set the printed runtime-file path.
UNREACHABLEKeep the runtime open and allow loopback traffic through the local firewall.
401Restart the runtime. Do not reuse metadata from another project or process.
Authorization deniedCheck internet access, entitlement status, device state, project scope and the minimum supported version.
Stale searchRefresh the local index and retry the query.

For support, include the Qorvyn version, operating system, error code and a redacted description. Never include secrets or private source.