spindb 0.31.3 → 0.32.2

package/README.md

@@ -7,7 +7,7 @@
 
 **One CLI for all your local databases.**
 
-SpinDB is a universal database management tool that combines a package manager, a unified API, and native client tooling for 16 different database engines—all from a single command-line interface. No Docker, no VMs, no platform-specific installers. Just databases, running natively on your machine.
+SpinDB is a universal database management tool that combines a package manager, a unified API, and native client tooling for 17 different database engines—all from a single command-line interface. No Docker, no VMs, no platform-specific installers. Just databases, running natively on your machine.
 
 ```bash
 npm install -g spindb
@@ -28,7 +28,7 @@ spindb create cache --engine redis
 
 ## Supported Engines & Platforms
 
-SpinDB supports **16 database engines** across **5 platform architectures**—all with a consistent API.
+SpinDB supports **17 database engines** across **5 platform architectures**—all with a consistent API.
 
 | Engine | Type | macOS ARM | macOS Intel | Linux x64 | Linux ARM | Windows |
 |--------|------|:---------:|:-----------:|:---------:|:---------:|:-------:|
@@ -48,8 +48,9 @@ SpinDB supports **16 database engines** across **5 platform architectures**—al
 | 🪳 **CockroachDB** | Distributed SQL | ✅ | ✅ | ✅ | ✅ | ✅ |
 | 🌀 **SurrealDB** | Multi-Model | ✅ | ✅ | ✅ | ✅ | ✅ |
 | ⏱️ **QuestDB** | Time-Series | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 🤖 **TypeDB** | Knowledge Graph | ✅ | ✅ | ✅ | ✅ | ✅ |
 
-**78 combinations. One CLI. Zero configuration.**
+**83 combinations. One CLI. Zero configuration.**
 
 > ClickHouse and FerretDB are available on Windows via WSL.
 
@@ -77,7 +78,7 @@ One consistent interface across SQL databases, document stores, key-value stores
 
 ```bash
 # Same commands work for ANY database
-spindb create mydb --engine [postgresql|mysql|mariadb|mongodb|ferretdb|redis|valkey|clickhouse|sqlite|duckdb|qdrant|meilisearch|couchdb|cockroachdb|surrealdb|questdb]
+spindb create mydb --engine [postgresql|mysql|mariadb|mongodb|ferretdb|redis|valkey|clickhouse|sqlite|duckdb|qdrant|meilisearch|couchdb|cockroachdb|surrealdb|questdb|typedb]
 spindb start mydb
 spindb connect mydb
 spindb backup mydb
@@ -173,7 +174,7 @@ SpinDB runs databases as **native processes** with **isolated data directories**
 
 | Feature | SpinDB | DBngin | Postgres.app | Laragon |
 |---------|--------|--------|--------------|---------|
-| **Engines supported** | 16 | 3 (PG/MySQL/Redis) | 1 (PostgreSQL) | 4 (PG/MySQL/MariaDB/MongoDB) |
+| **Engines supported** | 17 | 3 (PG/MySQL/Redis) | 1 (PostgreSQL) | 4 (PG/MySQL/MariaDB/MongoDB) |
 | CLI-first | ✅ | ❌ GUI-only | ❌ GUI-only | ⚠️ Limited CLI |
 | Multi-version support | ✅ | ✅ | ✅ | ✅ |
 | Built-in backup/restore | ✅ | ✅ | ❌ | ⚠️ Manual |
@@ -189,7 +190,7 @@ SpinDB runs databases as **native processes** with **isolated data directories**
 
 | Feature | SpinDB | Docker Desktop | Podman | OrbStack |
 |---------|--------|----------------|--------|----------|
-| **Engines supported** | 16 unified | Any (manual setup) | Any (manual setup) | Any (manual setup) |
+| **Engines supported** | 17 unified | Any (manual setup) | Any (manual setup) | Any (manual setup) |
 | Daemon required | ❌ | ✅ | ❌ (rootless) | ✅ |
 | Resource overhead | Native | VM + containers | VM + containers | VM + containers |
 | Built-in backup/restore | ✅ | ❌ Manual | ❌ Manual | ❌ Manual |
@@ -205,7 +206,7 @@ SpinDB runs databases as **native processes** with **isolated data directories**
 
 | Feature | SpinDB | Homebrew | apt/winget | asdf-vm |
 |---------|--------|----------|------------|---------|
-| **Engines supported** | 16 unified | Many (separate formulas) | Many (separate packages) | Many (plugins) |
+| **Engines supported** | 17 unified | Many (separate formulas) | Many (separate packages) | Many (plugins) |
 | Multi-version side-by-side | ✅ | ⚠️ Complex | ❌ | ✅ |
 | Isolated data directories | ✅ | ❌ System-wide | ❌ System-wide | ❌ |
 | Built-in backup/restore | ✅ | ❌ | ❌ | ❌ |
@@ -222,7 +223,7 @@ SpinDB runs databases as **native processes** with **isolated data directories**
 
 ## Supported Databases
 
-SpinDB supports **16 database engines** with **multiple versions** for each:
+SpinDB supports **17 database engines** with **multiple versions** for each:
 
 | Engine | Type | Versions | Default Port | Query Language |
 |--------|------|----------|--------------|----------------|
@@ -242,10 +243,11 @@ SpinDB supports **16 database engines** with **multiple versions** for each:
 | 🪳 **CockroachDB** | Distributed SQL | 25 | 26257 | SQL (PostgreSQL-compatible) |
 | 🌀 **SurrealDB** | Multi-Model | 2 | 8000 | SurrealQL |
 | ⏱️ **QuestDB** | Time-Series SQL | 9 | 8812 (PG), 9000 (HTTP) | SQL |
+| 🤖 **TypeDB** | Knowledge Graph | 3 | 1729, 8000 (HTTP) | TypeQL |
 
 ### Engine Categories
 
-**Server-Based Databases** (PostgreSQL, MySQL, MariaDB, MongoDB, FerretDB, Redis, Valkey, ClickHouse, Qdrant, Meilisearch, CouchDB, CockroachDB, SurrealDB, QuestDB):
+**Server-Based Databases** (PostgreSQL, MySQL, MariaDB, MongoDB, FerretDB, Redis, Valkey, ClickHouse, Qdrant, Meilisearch, CouchDB, CockroachDB, SurrealDB, QuestDB, TypeDB):
 - Start/stop server processes
 - Bind to localhost ports
 - Data stored in `~/.spindb/containers/{engine}/{name}/`
@@ -322,6 +324,23 @@ export DATABASE_URL=$(spindb url mydb)
 psql $(spindb url mydb)
 ```
 
+### User Management
+
+```bash
+# Create database users and API keys
+spindb users create mydb               # Auto-generate password
+spindb users create mydb --password p  # Use specific password
+spindb users create mydb --copy        # Copy connection string to clipboard
+spindb users create mydb --json        # JSON output for scripting
+spindb users create mydb --no-save     # Don't save credential file
+
+# List saved credentials
+spindb users list mydb                         # List usernames
+spindb users list mydb --json                  # JSON output
+```
+
+Supports PostgreSQL, MySQL, MariaDB, CockroachDB, ClickHouse, MongoDB, FerretDB, Redis, Valkey, SurrealDB, CouchDB, Meilisearch, and Qdrant. Not supported: SQLite, DuckDB, QuestDB, TypeDB. Credentials are saved as `.env.<username>` files in `~/.spindb/containers/{engine}/{name}/credentials/`.
+
 ### Backup & Restore
 
 ```bash
@@ -525,6 +544,7 @@ Each container contains:
 │   │   └── myapp/
 │   │       ├── container.json
 │   │       ├── data/
+│   │       ├── credentials/              # User credential .env.<username> files
 │   │       └── postgres.log
 │   ├── mysql/
 │   └── mongodb/
@@ -561,6 +581,7 @@ Databases run as **native processes**, and **data persists across restarts**. Wh
 | ClickHouse | MergeTree storage | Committed transactions survive crashes |
 | CockroachDB | Raft consensus | Strongly consistent, distributed replication |
 | QuestDB | Write-ahead logging | Committed transactions survive crashes |
+| TypeDB | Write-ahead logging | Committed transactions survive crashes |
 
 ---
 
@@ -763,6 +784,7 @@ SpinDB supports enhanced database shells with auto-completion, syntax highlighti
 | CouchDB | REST API | - | - |
 | CockroachDB | `cockroach sql` | - | - |
 | QuestDB | `psql` | `pgcli` | `usql` |
+| TypeDB | `typedb console` | - | - |
 
 Install and use in one command:
 
@@ -894,6 +916,16 @@ spindb backup mydb --format sql         # SQL dump (only format)
 
 > **Note:** QuestDB backup/restore requires the PostgreSQL engine to be installed (for `psql`).
 
+### TypeDB
+
+| Format | Extension | Tool | Use Case |
+|--------|-----------|------|----------|
+| typeql | `.typeql` | typedb console | TypeQL schema + data export |
+
+```bash
+spindb backup mydb --format typeql      # TypeQL export (only format)
+```
+
 ---
 
 ## Advanced Features
@@ -938,6 +970,7 @@ spindb restore mydb --from-url "postgresql://user:pass@prod-host:5432/production
 | CouchDB | `couchdb://` or `http://` | `http://user:pass@host:5984/db` |
 | CockroachDB | `postgresql://` or `postgres://` | `postgresql://root@host:26257/db?sslmode=disable` |
 | QuestDB | `postgresql://` or `postgres://` | `postgresql://admin:quest@host:8812/qdb` |
+| TypeDB | `typedb://` | `typedb://host:1729` |
 
 ### Multi-Version Support
 
@@ -1092,7 +1125,7 @@ See [USE_CASES.md](USE_CASES.md) for detailed use cases and infrastructure oppor
 
 SpinDB is powered by:
 
-- **[hostdb](https://github.com/robertjbass/hostdb)** - Pre-compiled database binaries for 16 engines across all major platforms. Makes Docker-free multi-version database support possible.
+- **[hostdb](https://github.com/robertjbass/hostdb)** - Pre-compiled database binaries for 17 engines across all major platforms. Makes Docker-free multi-version database support possible.
 
 ---
 

package/cli/commands/engines.ts

@@ -44,6 +44,10 @@ import {
   type InstalledQdrantEngine,
   type InstalledMeilisearchEngine,
   type InstalledCouchDBEngine,
+  type InstalledCockroachDBEngine,
+  type InstalledSurrealDBEngine,
+  type InstalledQuestDBEngine,
+  type InstalledTypeDBEngine,
 } from '../helpers'
 import { Engine, Platform } from '../../types'
 import {
@@ -65,6 +69,7 @@ import { couchdbBinaryManager } from '../../engines/couchdb/binary-manager'
 import { cockroachdbBinaryManager } from '../../engines/cockroachdb/binary-manager'
 import { surrealdbBinaryManager } from '../../engines/surrealdb/binary-manager'
 import { questdbBinaryManager } from '../../engines/questdb/binary-manager'
+import { typedbBinaryManager } from '../../engines/typedb/binary-manager'
 import {
   DEFAULT_DOCUMENTDB_VERSION,
   normalizeDocumentDBVersion,
@@ -458,6 +463,18 @@ async function listEngines(options: { json?: boolean }): Promise<void> {
   const couchdbEngines = engines.filter(
     (e): e is InstalledCouchDBEngine => e.engine === 'couchdb',
   )
+  const cockroachdbEngines = engines.filter(
+    (e): e is InstalledCockroachDBEngine => e.engine === 'cockroachdb',
+  )
+  const surrealdbEngines = engines.filter(
+    (e): e is InstalledSurrealDBEngine => e.engine === 'surrealdb',
+  )
+  const questdbEngines = engines.filter(
+    (e): e is InstalledQuestDBEngine => e.engine === 'questdb',
+  )
+  const typedbEngines = engines.filter(
+    (e): e is InstalledTypeDBEngine => e.engine === 'typedb',
+  )
 
   // Calculate total size for PostgreSQL
   const totalPgSize = pgEngines.reduce((acc, e) => acc + e.sizeBytes, 0)
@@ -626,6 +643,62 @@ async function listEngines(options: { json?: boolean }): Promise<void> {
     )
   }
 
+  // CockroachDB rows
+  for (const engine of cockroachdbEngines) {
+    const platformInfo = `${engine.platform}-${engine.arch}`
+
+    console.log(
+      chalk.gray('  ') +
+        getEngineIcon('cockroachdb') +
+        chalk.cyan('cockroachdb'.padEnd(13)) +
+        chalk.yellow(engine.version.padEnd(12)) +
+        chalk.gray(platformInfo.padEnd(18)) +
+        chalk.white(formatBytes(engine.sizeBytes)),
+    )
+  }
+
+  // SurrealDB rows
+  for (const engine of surrealdbEngines) {
+    const platformInfo = `${engine.platform}-${engine.arch}`
+
+    console.log(
+      chalk.gray('  ') +
+        getEngineIcon('surrealdb') +
+        chalk.cyan('surrealdb'.padEnd(13)) +
+        chalk.yellow(engine.version.padEnd(12)) +
+        chalk.gray(platformInfo.padEnd(18)) +
+        chalk.white(formatBytes(engine.sizeBytes)),
+    )
+  }
+
+  // QuestDB rows
+  for (const engine of questdbEngines) {
+    const platformInfo = `${engine.platform}-${engine.arch}`
+
+    console.log(
+      chalk.gray('  ') +
+        getEngineIcon('questdb') +
+        chalk.cyan('questdb'.padEnd(13)) +
+        chalk.yellow(engine.version.padEnd(12)) +
+        chalk.gray(platformInfo.padEnd(18)) +
+        chalk.white(formatBytes(engine.sizeBytes)),
+    )
+  }
+
+  // TypeDB rows
+  for (const engine of typedbEngines) {
+    const platformInfo = `${engine.platform}-${engine.arch}`
+
+    console.log(
+      chalk.gray('  ') +
+        getEngineIcon('typedb') +
+        chalk.cyan('typedb'.padEnd(13)) +
+        chalk.yellow(engine.version.padEnd(12)) +
+        chalk.gray(platformInfo.padEnd(18)) +
+        chalk.white(formatBytes(engine.sizeBytes)),
+    )
+  }
+
   console.log(chalk.gray('  ' + '─'.repeat(59)))
 
   // Summary
@@ -735,6 +808,50 @@ async function listEngines(options: { json?: boolean }): Promise<void> {
       ),
     )
   }
+  if (cockroachdbEngines.length > 0) {
+    const totalCockroachDBSize = cockroachdbEngines.reduce(
+      (acc, e) => acc + e.sizeBytes,
+      0,
+    )
+    console.log(
+      chalk.gray(
+        `  CockroachDB: ${cockroachdbEngines.length} version(s), ${formatBytes(totalCockroachDBSize)}`,
+      ),
+    )
+  }
+  if (surrealdbEngines.length > 0) {
+    const totalSurrealDBSize = surrealdbEngines.reduce(
+      (acc, e) => acc + e.sizeBytes,
+      0,
+    )
+    console.log(
+      chalk.gray(
+        `  SurrealDB: ${surrealdbEngines.length} version(s), ${formatBytes(totalSurrealDBSize)}`,
+      ),
+    )
+  }
+  if (questdbEngines.length > 0) {
+    const totalQuestDBSize = questdbEngines.reduce(
+      (acc, e) => acc + e.sizeBytes,
+      0,
+    )
+    console.log(
+      chalk.gray(
+        `  QuestDB: ${questdbEngines.length} version(s), ${formatBytes(totalQuestDBSize)}`,
+      ),
+    )
+  }
+  if (typedbEngines.length > 0) {
+    const totalTypeDBSize = typedbEngines.reduce(
+      (acc, e) => acc + e.sizeBytes,
+      0,
+    )
+    console.log(
+      chalk.gray(
+        `  TypeDB: ${typedbEngines.length} version(s), ${formatBytes(totalTypeDBSize)}`,
+      ),
+    )
+  }
   console.log()
 }
 
@@ -1835,9 +1952,70 @@ enginesCommand
         return
       }
 
+      if (['typedb', 'tdb'].includes(normalizedEngine)) {
+        if (!version) {
+          console.error(uiError('TypeDB requires a version (e.g., 3)'))
+          process.exit(1)
+        }
+
+        const { platform, arch } = platformService.getPlatformInfo()
+        const platformKey = `${platform}-${arch}`
+        const supportedPlatforms = new Set([
+          'darwin-x64',
+          'darwin-arm64',
+          'linux-x64',
+          'linux-arm64',
+          'win32-x64',
+        ])
+        if (!supportedPlatforms.has(platformKey)) {
+          console.error(
+            uiError(
+              `TypeDB binaries are not available for ${platformKey}. Supported: darwin-x64, darwin-arm64, linux-x64, linux-arm64, win32-x64.`,
+            ),
+          )
+          process.exit(1)
+        }
+
+        const engine = getEngine(Engine.TypeDB)
+
+        const spinner = createSpinner(`Checking TypeDB ${version} binaries...`)
+        spinner.start()
+
+        let wasCached = false
+        await engine.ensureBinaries(version, ({ stage, message }) => {
+          if (stage === 'cached') {
+            wasCached = true
+            spinner.text = `TypeDB ${version} binaries ready (cached)`
+          } else {
+            spinner.text = message
+          }
+        })
+
+        if (wasCached) {
+          spinner.succeed(`TypeDB ${version} binaries already installed`)
+        } else {
+          spinner.succeed(`TypeDB ${version} binaries downloaded`)
+        }
+
+        // Show the path for reference
+        const { platform: typedbPlatform, arch: typedbArch } =
+          platformService.getPlatformInfo()
+        const typedbFullVersion = typedbBinaryManager.getFullVersion(version)
+        const binPath = paths.getBinaryPath({
+          engine: 'typedb',
+          version: typedbFullVersion,
+          platform: typedbPlatform,
+          arch: typedbArch,
+        })
+        console.log(chalk.gray(`  Location: ${binPath}`))
+
+        // Skip client tools check - TypeDB console is bundled
+        return
+      }
+
       console.error(
         uiError(
-          `Unknown engine "${engineName}". Supported: postgresql, mysql, mariadb, sqlite, duckdb, mongodb, ferretdb, redis, valkey, clickhouse, qdrant, meilisearch, couchdb, cockroachdb, surrealdb, questdb`,
+          `Unknown engine "${engineName}". Supported: postgresql, mysql, mariadb, sqlite, duckdb, mongodb, ferretdb, redis, valkey, clickhouse, qdrant, meilisearch, couchdb, cockroachdb, surrealdb, questdb, typedb`,
         ),
       )
       process.exit(1)

package/cli/commands/menu/backup-handlers.ts

@@ -51,6 +51,7 @@ import { getEngineIcon, getPageSize } from '../../constants'
 import { Engine, assertExhaustive } from '../../../types'
 import { pressEnterToContinue } from './shared'
 import { SpinDBError, ErrorCodes } from '../../../core/error-handler'
+import { validateTypedbConnectionString } from './validators'
 
 // Strip surrounding quotes from paths (handles drag-and-drop paths)
 function stripQuotes(path: string): string {
@@ -207,6 +208,12 @@ function validateConnectionString(
         return 'Connection string must start with postgresql:// or postgres://'
       }
       break
+    case Engine.TypeDB:
+      {
+        const typedbError = validateTypedbConnectionString(input)
+        if (typedbError) return typedbError
+      }
+      break
     case Engine.SQLite:
     case Engine.DuckDB:
       return 'File-based engines do not support remote connection strings'