Getting Started

Getting Started with KairoDB

KairoDB is designed to be simple and local-first. Here is how you can get up and running in minutes.

1. Installation

Without Rust (Pre-built Binaries)

1. Go to the Releases page.
2. Download the binary for your operating system (Linux, macOS, or Windows).
3. Move the binary to a directory in your system's PATH (e.g., /usr/local/bin or a custom folder).

With Rust (From Source)

If you have Rust installed:

cargo install --path .

2. Initialize your project

Run the following command in your project directory:

kairo init

This creates the following structure:

• kairo.config: Main configuration file.
• schema/: Where you define your tables.
• data/: Local storage (for SQLite).
• migrations/, queries/, plugins/: Expansion folders.

3. Define a schema

Create a file schema/users.kairo:

table users {
  name: string
  age: int
  active: bool = true
}

4. Apply the schema

kairo create users

5. Query your data

kairo query "from users"