Documentation

Getting started

Quickstart

Two ways to get Swifbit running: a one-command Docker install for evaluation, or a local development checkout. Both can load a complete demo workspace.

Access & licensing

Swifbit is commercial software distributed under a per-organization license. The source repository is private — access is granted to licensed customers and teams under evaluation. When your license is issued, we invite your engineers to the GitHub repository and provide the release bundle with signed connector packages.

  • Evaluating? Request a demo — we’ll walk you through the product on your use case and set up evaluation access.
  • Purchasing or need repository access? Contact our team via the contact form or email [email protected].
  • License keys — deployments are activated with a license key issued at purchase. Online license validation is on the roadmap; today keys are verified at install.
The commands below assume your GitHub account has been granted access to the private repository. If a git clone fails with an authentication error, your access has not been set up yet — reach out and we’ll sort it quickly.

Prerequisites

  • A Swifbit license and access to the private repository (see above)
  • Node 20+ and pnpm (for local development)
  • Docker, or a local PostgreSQL 16 with the pgvector extension
  • Optional for live AI answers: Ollama with a chat and embedding model pulled, or any OpenAI-compatible API key

Option 1 — Docker (recommended)

Clone the repository and run the installer. It builds and starts PostgreSQL and Swifbit.

shell
git clone https://github.com/Swifbit/swifbit.git && cd swifbit
./install.sh            # builds and starts Postgres + Swifbit on :4000
./install.sh --demo     # same, then seeds the demo workspace

Open http://localhost:4000. The first visit walks you through creating the admin account and workspace.

Option 2 — Local development

shell
pnpm install
cp .env.example .env
docker compose up -d db   # Postgres + pgvector on :5433
pnpm dev                  # kernel :4000, web :5173 (hot reload)

Load the demo workspace

One command loads a fictional company — “Nimbus Host” — with 47 documents across 10 sources, three users, and two teams with scoped access.

shell
pnpm demo:seed

Sign in as [email protected] / swifbit123 (also priya@ for Support and arjun@ for Sales).

A good first query: “What is our uptime commitment on the Business plan?” — note the numbered citations and the confidence badge on the answer.
The demo credentials are for local evaluation only. Change them before exposing any environment beyond your machine.