Quickstart

npm install -g @hoodiecollin/forgedb    # or: bun add -g @hoodiecollin/forgedb

uv tool install hoodiecollin-forgedb    # or: pip install hoodiecollin-forgedb

cargo install forgedb

# no Go-native CLI channel — use the universal shell installer (macOS/Linux):
curl -fsSL https://get.forgedb.dev/install.sh | sh

forgedb generate node --sdk   # → generated/types.ts  (bun --sdk is equivalent)

forgedb generate python --sdk # → generated/python-sdk/forgedb_client.py

forgedb generate rust --sdk   # → generated/rust-sdk/  (a reqwest client crate)

forgedb generate go --sdk     # → generated/go-sdk/client.go

import { ForgeDBClient } from './generated/types';
 
const db = new ForgeDBClient('http://localhost:3000');
 
// list → ListResult<T> = { data, total, limit, offset }
const { data, total } = await db.listUser({ limit: 20, sort: 'username' });
 
// get → the row, or null on 404
const user = await db.getUser('11111111-1111-1111-1111-111111111111');
 
// create → the new id; throws ForgeDBError on 409/422
const id = await db.createUser({
  username: 'grace', email: 'grace@example.com',
  password_hash: 'x', created_at: Date.now(), posts: null,
});
 
// update → false if the id doesn't exist; delete → true/false
await db.updateUser(id, { /* full record */ });
await db.deleteUser(id);

const res = await fetch('http://localhost:3000/api/user', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    username: 'grace', email: 'grace@example.com', password_hash: 'x', posts: null,
  }),
});
const { id } = await res.json();   // → { id: "<server-generated uuid>" }

from forgedb_client import ForgeDbClient, UserCreate, ListOptions
 
db = ForgeDbClient("http://localhost:3000")
 
# list → ListResult { data, total, limit, offset }
page = db.list_user(ListOptions(sort="username", limit=20))
 
# get → the row, or None on 404
user = db.get_user("11111111-1111-1111-1111-111111111111")
 
# create → the new id; raises ForgeDbError on 409/422
user_id = db.create_user(UserCreate(
    username="grace",
    email="grace@example.com",
    password_hash="x",
    created_at=0,
))
 
# update → False if the id doesn't exist; delete → True/False
db.delete_user(user_id)

use forgedb_client::{ForgeDbClient, UserCreate, ListOptions};
 
let db = ForgeDbClient::new("http://localhost:3000");
 
// list → ListResult<User> { data, total, limit, offset }
let page = db.list_user(&ListOptions {
    sort: Some("username".into()),
    limit: Some(20),
    ..Default::default()
}).await?;
 
// get → Option<User> (None on 404)
let user = db.get_user("11111111-1111-1111-1111-111111111111").await?;
 
// create → the new id; Err(ForgeDbError) on 409/422
let id = db.create_user(&UserCreate {
    username: "grace".into(),
    email: "grace@example.com".into(),
    password_hash: "x".into(),
    created_at: 0,
    ..Default::default()
}).await?;

db := forgedbclient.NewClient("http://localhost:3000")
 
// ListUser → *ListResult[User] { Data, Total, Limit, Offset }
limit := 20
page, err := db.ListUser(&forgedbclient.ListOptions{Sort: "username", Limit: &limit})
 
// GetUser → (*User, error); nil on 404
user, err := db.GetUser("11111111-1111-1111-1111-111111111111")
 
// CreateUser → the new id; non-nil err on 409/422
id, err := db.CreateUser(&forgedbclient.UserCreate{
    Username:     "grace",
    Email:        "grace@example.com",
    PasswordHash: "x",
})