Installation

ForgeKit provides an interactive command line interface (CLI) to scaffold new projects or install individual modules into existing codebases.

Scaffold a New Project

To initialize a brand new application with the full ForgeKit setup, run the following command in your terminal:

npm create forgekit@latest

This interactive assistant will prompt you for:

1. Project Location: The target subdirectory (e.g. ./my-forge-app).
2. Edge Environment Target: Cloudflare Workers, Vercel Edge, or Node.js.
3. Modules Setup: Toggle @forgekit/auth, @forgekit/db, @forgekit/logger, or @forgekit/config.

Add to Existing Codebase

If you have a SvelteKit, Next.js, or Hono application and want to add ForgeKit libraries, you can install the specific packages directly via standard package managers.

1. Identity & Session Setup

npm install @forgekit/core @forgekit/auth

2. Database transaction pools

npm install @forgekit/core @forgekit/db

3. Structured Observability Loggers

npm install @forgekit/logger

4. Schema Environmental Configs

npm install @forgekit/config

Compiler Prerequisites

ForgeKit leverages TypeScript v5 characteristics. Verify that your tsconfig.json extends these properties to ensure correct compilation:

{
	"compilerOptions": {
		"moduleResolution": "bundler",
		"target": "ES2022",
		"strict": true,
		"esModuleInterop": true
	}
}