Skip to content
Chukfi Docs

Quick Start

Prerequisites

Section titled “Prerequisites”
  • Node.js 18+
  • Docker (for local PostgreSQL)
  • An AWS account (for production deployment)

Installation

Section titled “Installation”
Terminal window
npm install @chukfi/cli

Local Development

Section titled “Local Development”

Start the local development server:

Terminal window
npx chukfi dev

This will:

  1. Detect a Docker runtime (Docker Desktop, Colima, OrbStack, etc.)
  2. Spawn an ephemeral postgres:17-alpine container on port 5433
  3. Run embedded migrations
  4. Start the Rust API on port 8080

Initialize a Project

Section titled “Initialize a Project”
Terminal window
npx chukfi init

Scaffolds a new Astro project wired to Chukfi with the @chukfi/astro integration.

Deploy to Production

Section titled “Deploy to Production”
Terminal window
npx chukfi deploy

Provisions the full AWS stack via CDK and writes .env.production with all connection values.