CLI Reference

The UnrealORM CLI provides commands for managing your SurrealDB schema and database.

Installation

# npm
npm install -g unreal-orm

# pnpm
pnpm add -g unreal-orm

# bun
bun add -g unreal-orm

Commands

Command	Description
unreal docs	Open the UnrealORM documentation
unreal github	Open the UnrealORM GitHub repository
unreal init	Initialize UnrealORM in your project
unreal view	Interactive TUI for browsing database tables and records

Global Options

All commands support the following global options:

unreal --version  # Show version number
unreal --help     # Show help