Quick Start

Install Moul

Install the official pre-compiled binaries via the automated install script. This installs both moul (the server daemon) and moul-ctl (the terminal management client) directly into /usr/local/bin:

# Downloads and installs 'moul' and 'moul-ctl' binaries
curl -fsSL https://moul.dev/install.sh | sh

moul --version
moul-ctl --version

# Extract the archive and move binaries to your system PATH
tar -xzf moul_*_$(uname -s | tr '[:upper:]' '[:lower:]')_amd64.tar.gz
sudo mv moul /usr/local/bin/

tar -xzf moul-ctl_*_$(uname -s | tr '[:upper:]' '[:lower:]')_amd64.tar.gz
sudo mv moul-ctl /usr/local/bin/

Start the Local Engine

Start the moul server engine. By default, it creates an embedded SQLite database (moul-local.db), launches the background worker pool, and listens on port :8090:

moul start

You should see startup logs confirming the database is ready:

{"time":"...","level":"INFO","msg":"Database initialized at moul-local.db"}
{"time":"...","level":"INFO","msg":"Worker engine started with 10 workers"}
{"time":"...","level":"INFO","msg":"Server listening on :8090"}

moul start --db /path/to/my-app.db

Seed Demo Data & Schema Fixtures

In a new terminal window, populate your database with demonstration collections (users, posts, categories, tasks_queue, events), relationship records, worker jobs, and OpenFeature flags:

moul seed

Output:

Seeding database at: moul-local.db...
Successfully seeded database with demo collections, records, and feature flags!

Access the Admin Consoles

Moul includes two built-in management interfaces to inspect and configure your engine:

1. Web Admin Console (Browser)

Open http://localhost:8090/moul/ in your web browser.

• Complete the initial root admin setup or log in with your master administrative key (MOUL_ADMIN_KEY).
• Browse dynamic collections, edit schema fields visually, monitor background worker queues, and inspect real-time telemetry.

2. Terminal User Interface (moul-ctl)

Launch the keyboard-driven terminal console in your terminal:

moul-ctl
# Or via convenience subcommand:
moul ctl

• When prompted, connect to http://localhost:8090 using your admin key.
• Use arrow keys and shortcuts to navigate collections, inspect JSON records, and manage worker queues without leaving the terminal.

Perform Your First API Call

Query the newly seeded posts collection from your terminal or application code:

# List records in the "posts" collection
curl -s "http://localhost:8090/api/moul/posts/records?page=1&perPage=10"

interface Post {
  id: string;
  title: string;
  content: string;
  published: boolean;
}

const response = await fetch('http://localhost:8090/api/moul/posts/records?page=1&perPage=10');
const data = await response.json();
console.log(data.items);

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	resp, err := http.Get("http://localhost:8090/api/moul/posts/records?page=1&perPage=10")
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var result map[string]any
	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
		panic(err)
	}
	fmt.Printf("Fetched %v records\n", result["totalItems"])
}