Skip to content
🚀 This documentation is for unreal-orm 1.0.0 alpha which requires SurrealDB 2.0 SDK. For use with version 1.x, see here.

unreal init

Initialize UnrealORM in your project

Terminal window
unreal init [options]
Option Description Default
--url <url> SurrealDB URL -
-u, --username <username> Database username -
-p, --password <password> Database password -
-n, --namespace <ns> Namespace -
-d, --database <db> Database -
-e, --embedded <mode> Embedded mode (memory or file path) -
--sample Generate sample schema tables -
--from-db Import schema from existing database -
--from-surql <file> Import schema from .surql file -
--install Install dependencies automatically -
--no-install Skip dependency installation -
--pm <manager> Package manager (npm, yarn, pnpm, bun) -