Skip to content
🚀 This documentation is for unreal-orm 1.0.0 alpha which requires SurrealDB 2.0 alpha SDK. For the stable version, see npm.

unreal init

Initialize UnrealORM in your project

Terminal window
unreal init [options]
OptionDescriptionDefault
--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)-
--sampleGenerate sample schema tables-
--from-dbImport schema from existing database-
--from-surql <file>Import schema from .surql file-
--installInstall dependencies automatically-
--no-installSkip dependency installation-
--pm <manager>Package manager (npm, yarn, pnpm, bun)-