Installation and loading

Stardust runs inside your application. Install the library and the binding for your language from the same release.

Install the core

Extract the release archive for your platform. It contains the library under lib/, bindings under abi/bindings/, and runnable examples under abi/examples/.

PlatformArchitectureShared library
Linuxx86_64 or ARM64libstardust.so
macOSx86_64 or ARM64libstardust.dylib
Windowsx86_64stardust.dll

Use the installation quickstart for your language's build and run commands. The release examples use relative paths to the supplied library.

Load the core

The bindings use the C ABI. Go, Rust, Odin, and C link against the library. Python and Clojure load it at runtime. The runtime loader must find the library when the application starts.

PlatformRuntime library search
LinuxInstalled library directories or LD_LIBRARY_PATH
macOSThe application's library search paths or DYLD_LIBRARY_PATH
WindowsThe executable directory or PATH

Python and Clojure can select a library file with STARDUST_LIBRARY. On Linux and macOS, executable PATH does not select shared libraries. On Windows, linked applications also need the supplied stardust.lib import library at build time.

Static linking

The current release tasks build shared libraries. They do not yet package static Stardust archives.

After loading the core, select any required plugins when you open a database. Plugin installation explains which plugins are available.