Install

Install puts Keja on the machine and keja init creates the project. Build first service is the next page. It serves GET /v1/hello from that project. Keja publishes to npm as @veducio/keja.

bun add @veducio/keja zod

import { defineRoute, response } from "@veducio/keja";

The same name is also on GitHub Packages. That copy is restricted. An install from GitHub needs a token that can read packages from the veducio organization. Add this .npmrc before that install so the veducio scope comes from GitHub Packages:

@veducio:registry=https://npm.pkg.github.com

bun add @veducio/keja zod

keja init creates a project from the starter that ships inside the package. Bun and Git must be installed. The destination must be empty. Init copies the starter, writes package.json, keja.config.ts, and tsconfig.json, adds a public GET /hello and a service POST /ping, runs bun install, then runs git init. The new project depends on @veducio/keja. Init writes .npmrc for GitHub Packages when the package that ran init came from GitHub Packages. An npm install leaves that file out, so the new project installs from npm.

keja init --name my-app --dir ./my-app --public ./src/public --service ./src/service

Flag	Default
`--name`	`my-app`
`--dir`	`./<name>`
`--public`	`./src/public`
`--service`	`./src/service`

In a terminal, Enter accepts the default for any flag you omit. Without a terminal, omitted flags use those defaults. The public and service paths are relative to the new project and are written into keja.config.ts. The dependency is ^ plus the version of the Keja package that ran init. The generated scripts call the keja command. keja dev reloads the project when a route or a file it imports changes. Bun loads .env from the project directory.

{
  "scripts": {
    "dev": "keja dev",
    "start": "keja start"
  }
}

keja init copies .env.example to .env when .env is missing. Set HOST, HTTP_PORT, and HTTP_SERVICE_PORT before the first start. When db is enabled, also set DATABASE_URL.

Overview

Project

HTTP

Data

Integrations