Documentation

Get started in minutes

One command installs the complete Kiban BOS. Everything else is configuration.

Quick Start

Kiban BOS is distributed as a single CLI package. Run the init command inside your project root — it will clone the relevant module backends, scaffold the frontend bindings, and write your .env files.

terminal

# Install and scaffold Kiban BOS

$npx kiban@latest init

# Follow the interactive wizard:

? Which modules do you want to install? (Press space to select)

◉ UAPS — Auth & Profiles

◉ PREM — Payments & Revenue

◉ GREM — Growth & Analytics

◉ SAGE — Support & Docs

# After setup:

$kiban doctor

✔ All systems operational

What gets installed

UAPS

User Auth & Profile System

  • JWT + Magic Link auth
  • RBAC roles
  • Profile management
  • Supabase SSR
View docs
PREM

Payments & Revenue Engine

  • Stripe / Lemon Squeezy / Mercado Pago
  • Credit ledger
  • Webhook security
  • 14-day trials
View docs
GREM

Growth & Analytics Engine

  • SEO automation
  • Event analytics bus
  • Waitlist + referrals
  • Feedback board
View docs
SAGE

Support & Guidance Engine

  • Knowledge base
  • Onboarding checklists
  • Support tickets
  • Contextual docs
View docs

Prerequisites

Node.js

Required for the CLI and frontend

20+
Python

Required for backend modules (FastAPI)

3.12+
Supabase project

Free tier works. Have your project URL and keys ready.

—
Git

Used by the CLI to clone module templates

2.x+

CLI Reference

After installation, the kiban binary is available globally. All commands support --help.

npx kiban@latest init

Scaffold the full Kiban BOS into your project. Interactive wizard walks you through module selection, database connection, and environment setup.

kiban doctor

Validates environment variables, checks database connectivity, verifies migration state, and reports any configuration issues.

kiban seed

Populates the database with default plans (basic/pro/enterprise), roles (user/manager/admin), and a dev admin account.

kiban migrate

Runs pending SQL migrations in the correct dependency order: UAPS → PREM → GREM.

kiban dev

Starts all module backends in parallel using the correct ports (UAPS :8000, PREM :8001, GREM :8002, SAGE :8003).

Module Deep Dives

UAPS — User Auth & Profile System

JWT + Magic Link auth · RBAC roles · Profile management · Supabase SSR

PREM — Payments & Revenue Engine

Stripe / Lemon Squeezy / Mercado Pago · Credit ledger · Webhook security · 14-day trials

GREM — Growth & Analytics Engine

SEO automation · Event analytics bus · Waitlist + referrals · Feedback board

SAGE — Support & Guidance Engine

Knowledge base · Onboarding checklists · Support tickets · Contextual docs

Need help?

Open a support ticket, check the changelog, or reach out directly.

Contact supportView changelog