Installation

Codexa Core is published on JSR as @codexa/core. JSR serves both Deno style and npm style package managers from one registry, so the same package installs cleanly across runtimes.

Requirements

Codexa Core targets Deno as its primary runtime. Install the latest stable release of Deno before you continue.

Some parts of the framework, such as the Deno KV store mode and the local disk storage provider, use Deno specific APIs directly and only run on Deno. The HTTP layer itself does not, and is covered in Introduction.

Install

deno add jsr:@codexa/core

Adds @codexa/core to the imports field of your project's deno.json.

Every option adds @codexa/core to your project, ready to import a subpath.

import { createApp, definePlugin } from '@codexa/core/http';

Deno also accepts a jsr: specifier directly, with no install step first.

import { createApp, definePlugin } from 'jsr:@codexa/core/http';

Starting a server on Node.js still needs a Fetch API adapter, such as @hono/node-server, since Node does not accept a fetch handler the way Deno and Bun do. See Runs wherever the Fetch API runs in the introduction for a working example.

Import maps

A project that manages its imports through deno.json or package.json can list only the subpaths it actually uses, and add more as the project grows.

deno.json

{
  "imports": {
    "@codexa/core/http": "jsr:@codexa/core/http",
    "@codexa/core/config": "jsr:@codexa/core/config",
    "@codexa/core/store": "jsr:@codexa/core/store"
  }
}

The full subpath list is on the Introduction page.

What you get

Package: @codexa/core
Registry: jsr.io/@codexa/core
Source: github.com/Codexa-by-HQ/codexa-core
License: MIT
Runtimes: Deno, Node.js, Bun, and browsers, confirmed by JSR's own compatibility check

Quick Start

Build a small application and run it end to end.

HTTP Overview

The app lifecycle: boot, dispatch, and shutdown.