Skip to main content

Getting Started

Clone the repo​

git clone https://github.com/worka-ai/workadb.git
cd workadb/workadb/build

Build outputs​

WorkaDB build scripts produce:

  • lib/libworkadb.a (static library)
  • include/ (headers)
  • bin/postgres (helper binary for initdb)
  • share/workadb/pgdata-template (template data directory)

Build commands by platform​

macOS (arm64):

ARCH=arm64 ./build_desktop.sh

macOS (x86_64):

ARCH=x86_64 ./build_desktop.sh

Linux (x86_64):

ARCH=x86_64 ./build_desktop.sh

Windows:

Windows builds are not yet scripted. Use WSL2 and run the Linux build script.

iOS device:

SDK=iphoneos ARCH=arm64 ./build_ios.sh

iOS simulator (arm64 or x86_64):

SDK=iphonesimulator ARCH=arm64 ./build_ios.sh

Android device (arm64):

ANDROID_NDK=/path/to/ndk ARCH=arm64 API_LEVEL=24 ./build_android.sh

Android emulator (x86_64):

ANDROID_NDK=/path/to/ndk ARCH=x86_64 API_LEVEL=24 ./build_android.sh

Required environment variables​

At runtime, set:

  • WORKADB_TEMPLATE_PATH to the generated template directory.
  • WORKADB_EXEC_PATH to the postgres helper binary.

These allow the engine to copy a clean data directory on first launch.