Installation

TaiDB is distributed first as a Rust crate. The CLI is built from the same crate and is the easiest way to use TaiDB from scripts or languages without an official native package.

Requirements

• Rust 1.88 or newer.
• Cargo for building the library and CLI.
• A writable local filesystem path for database files.

The documentation site uses Node.js only for building docs. TaiDB itself does not require Node.

Install the Rust crate

Add TaiDB to an application:

cargo add taidb

Then import the high-level engine facade:

use taidb::EngineConfig;

Install the CLI

Install the published crate as a command:

cargo install taidb

Check that the binary is available:

taidb --help

Build from source

Clone the repository:

git clone https://github.com/mienetic/taiDB.git
cd taiDB

Run checks:

make check

Build release artifacts:

cargo build --release

The CLI binary will be available at:

target/release/taidb

Build native FFI artifacts

Enable the native-ffi feature:

cargo build --release --features native-ffi

Expected output:

• macOS: target/release/libtaidb.dylib
• Linux: target/release/libtaidb.so
• Windows: target/release/taidb.dll
• C header: include/taidb.h

Recommended setup by language

Language	Recommended path today	Notes
Rust	cargo add taidb	Primary supported API.
Shell	cargo install taidb	Best for automation and smoke tests.
Node.js	CLI bridge	Requires the taidb binary on PATH.
Python	Native FFI example	Build shared library first.
Go	Native FFI example	Uses cgo and the shared library.
C	Native FFI example	Uses include/taidb.h.

Upgrade safely

Before upgrading a running application, check:

1. The crate release notes.
2. The roadmap status for storage format changes.
3. Whether your database files need migration.
4. Whether your application depends on exact error variants or CLI output.

Before TaiDB reaches 1.0.0, storage format and public API changes may still occur.