forgedb 0.3.1

ForgeDB — an application database generator. Compiles a declarative .forge schema into tailored Rust database code, a TypeScript SDK, and a REST API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

---
title: "forgedb tenant"
description: "Manage physical, dir-per-tenant data directories for ForgeDB multi-tenancy."
purpose: "reference"
---
Manage physical, dir-per-tenant data directories. Multi-tenancy is filesystem-enforced: each tenant's data lives under `<root>/<tenant>/`, and one server process serves exactly one tenant (process-per-tenant). This command only creates, lists, or removes directories; it never reads a `.forge` schema.

## Subcommands

| Command | Purpose |
|---|---|
| `create <name>` | Create a tenant's (empty) data directory and print the serve incantation. |
| `list` | List tenant directories under the root. |
| `drop <name>` | Remove a tenant's data directory (destructive). |

<Callout type="note" title="Root precedence">
The tenant root resolves as `--root` flag &gt; `[tenant].root` in `forgedb.toml` &gt; `./data`.
A tenant name must be a single path segment — no separators, and not `.` or `..`.
</Callout>

### create

```bash
forgedb tenant create <name> [--root <DIR>]
```

| Flag | Type / default | Meaning |
|---|---|---|
| `<name>` | string (required) | Tenant name; becomes the directory under the root. |
| `-r`, `--root <DIR>` | string (config / `./data`) | Tenant root directory. |

### list

```bash
forgedb tenant list [--root <DIR>] [--json]
```

| Flag | Type / default | Meaning |
|---|---|---|
| `-r`, `--root <DIR>` | string (config / `./data`) | Tenant root directory. |
| `--json` | bool (false) | Emit JSON. |

### drop

```bash
forgedb tenant drop <name> [--root <DIR>] [--force]
```

| Flag | Type / default | Meaning |
|---|---|---|
| `<name>` | string (required) | Tenant name to remove. |
| `-r`, `--root <DIR>` | string (config / `./data`) | Tenant root directory. |
| `--force` | bool (false) | Skip the confirmation guard. |

## Examples

Create a tenant and read back the serve command it prints:

```bash
forgedb tenant create acme --root ./tenants
# ✓ Created tenant 'acme' at ./tenants/acme
#   Serve it with:  FORGEDB_TENANT=acme FORGEDB_DATA=./tenants <your-generated-binary>
```

List tenants as JSON:

```bash
forgedb tenant list --root ./tenants --json
```

Drop a tenant without the prompt:

```bash
forgedb tenant drop acme --root ./tenants --force
```