Skip to content

Introduction ​

These guides document the features implemented in the current source tree. A feature described as "validated" has a fixture or focused test in this repository. Oganesson is still under active development; read Compatibility and limitations before choosing it for a production workload.

Start here ​

  • Getting started - build og, install a project, produce an app binary, and run it.
  • Command-line reference - every og command and option, including the compatibility runner.
  • Development workflow - use each framework's normal development server and production scripts alongside the Oganesson build you deploy.
  • Project configuration - project detection, next.config, vite.config, og.config, build scripts, environment variables, and files generated by Oganesson.
  • Packaging and deployment - single-file binaries, cross-compilation, ejected Go modules, containers, and licenses.

Framework guides ​

  • Next.js - App Router, Pages Router, rendering, Server Actions, Cache Components, ISR, routing, CSS, fonts, images, and build hooks.
  • Vite and its framework ecosystem - Vite 5 through 8, SPAs, SSR servers, TanStack Start, Astro, VitePress, React Router, SvelteKit, Nuxt, SolidStart, and Qwik City.

Runtime and application services ​

  • Runtime compatibility - request isolation, Web APIs, Node.js compatibility, the packaged filesystem, WebAssembly, JavaScript and Intl support, and operational behavior.
  • Data, databases, and ORMs - og:kv, SQLite, PostgreSQL, MySQL, Drizzle, Kysely, TypeORM, Prisma, and startup schema migration.
  • Native Go modules - expose project-owned Go functions to JavaScript as typed og:<name> modules.
  • Compatibility and limitations - supported substitutions, partial compatibility, unsupported features, and the right way to interpret the support lists.

Feature map ​

The current compatibility target is Next.js 16.4.0 with React 19.3.0 (Pages Router fixtures also cover React 18) and Vite 5 through 8.

AreaImplemented surface
Installationnpm-registry installation without npm; npm, pnpm, and Yarn lockfiles; integrity verification; cache; workspaces; no lifecycle scripts
Type checkingTypeScript-Go-based og check, including generated declarations for built-in and project Go modules
Next.jsApp and Pages Routers, SSR/RSC, hydration, navigation, route handlers, API routes, Server Actions, proxy/middleware, static generation, ISR, Cache Components, i18n, basePath, trailingSlash, CSS, fonts, images, metadata, and build hooks
ViteVite 5-8 production builds, common UI plugins, static and SSR applications, server programs, and the validated meta-frameworks listed in the Vite guide
Runtimefresh Sobek VM per request, Web Platform APIs, broad Node built-in shims, process-wide Go services, outbound TCP/TLS, virtual packaged files, and WebAssembly
Datain-memory Deno-KV-style store; Go-backed SQLite, PostgreSQL, and MySQL drivers; Drizzle, Kysely, TypeORM, and Prisma 7
Packaging.og/ build output, one-file application binaries, cross-target packaging, standalone ejected Go modules, and embedded license notices
Extensibilityesbuild plugins, webpack-style loaders, selected Next webpack/Turbopack/Babel hooks, and typed user-defined Go modules

For contributor-facing internals, see ARCHITECTURE.md.

Released under the Apache License 2.0.