Complete reference for all RealmKit CLI commands. Use these commands to create projects, discover templates, publish realms, and manage your RealmKit workflow.
Most commonly used commands to get you started
realmkit create saas-starter my-apprealmkit list --popularrealmkit search "next.js"realmkit help createCommands for creating and managing RealmKit projects
realmkit createCreate a new project from a realm template
realmkit create <realm-name> [project-name] [options]realmkit create saas-starter my-apprealmkit create next-blog --typescriptrealmkit create vue-admin my-dashboard --git--gitInitialize git repository--typescriptUse TypeScript variant if available--installAuto-install dependencies (default: true)--no-installSkip dependency installationrealmkit initInitialize RealmKit in an existing project
realmkit init [options]realmkit initrealmkit init --force--forceOverwrite existing configurationCommands for finding and exploring realm templates
realmkit listList available realm templates
realmkit list [category] [options]realmkit listrealmkit list saasrealmkit list --popularrealmkit list --author=realmkit--popularShow only popular realms--recentShow recently updated realms--author=<name>Filter by author--limit=<number>Limit number of resultsrealmkit searchSearch for realms by name, description, or tags
realmkit search <query> [options]realmkit search "next.js"realmkit search authentication --category=saasrealmkit search --tag=typescript--category=<cat>Filter by category--tag=<tag>Filter by tag--fuzzyEnable fuzzy matchingrealmkit infoShow detailed information about a realm
realmkit info <realm-name>realmkit info saas-starterrealmkit info next-blog --json--jsonOutput in JSON formatCommands for publishing and managing your own realms
realmkit publishPublish a realm template to the registry
realmkit publish [path] [options]realmkit publishrealmkit publish ./my-realm --publicrealmkit publish --draft--publicMake realm publicly visible--privateKeep realm private--draftPublish as draft--forceForce publish with warningsrealmkit updateUpdate an existing published realm
realmkit update <realm-name> [options]realmkit update my-realmrealmkit update my-realm --version=1.2.0--version=<ver>Set specific version--patchIncrement patch version--minorIncrement minor version--majorIncrement major versionrealmkit unpublishRemove a realm from the registry
realmkit unpublish <realm-name> [version]realmkit unpublish my-realmrealmkit unpublish my-realm 1.0.0--forceSkip confirmation promptCommands for managing RealmKit configuration
realmkit configManage RealmKit configuration settings
realmkit config <action> [key] [value]realmkit config listrealmkit config get apiKeyrealmkit config set defaultCategory saasrealmkit config unset apiKey--globalUse global configuration--localUse project configurationrealmkit loginAuthenticate with RealmKit registry
realmkit login [options]realmkit loginrealmkit login --token=<api-key>--token=<key>Login with API keyrealmkit logoutSign out from RealmKit registry
realmkit logoutrealmkit logoutrealmkit whoamiShow current authenticated user
realmkit whoamirealmkit whoamiHelper commands and utilities
realmkit versionShow RealmKit CLI version information
realmkit version [options]realmkit versionrealmkit version --json--jsonOutput in JSON formatrealmkit helpDisplay help information
realmkit help [command]realmkit helprealmkit help createrealmkit help searchrealmkit doctorDiagnose common issues and verify setup
realmkit doctorrealmkit doctor--fixAttempt to fix issues automaticallyrealmkit cacheManage local cache
realmkit cache <action>realmkit cache clearrealmkit cache inforealmkit cache cleanOptions that work with all RealmKit commands
--verbose, -vEnable verbose output--quiet, -qSuppress non-error output--help, -hShow help for command--versionShow version number--config=<path>Use custom config file--no-colorDisable colored outputTypical workflows and command combinations
# Search for a suitable realm
realmkit search "saas" --tag=typescript
# Get details about a realm
realmkit info saas-starter
# Create your project
realmkit create saas-starter my-startup
# Navigate and start developing
cd my-startup
npm run dev# Login to RealmKit
realmkit login
# Initialize realm in your project
realmkit init
# Publish as draft first
realmkit publish --draft
# Make it public when ready
realmkit update my-realm --public# Set up your preferences
realmkit config set defaultCategory saas
realmkit config set authorName "Your Name"
realmkit config set authorEmail "you@example.com"
# View current configuration
realmkit config listCommon issues and their solutions
If you get "realmkit: command not found", the CLI might not be installed or not in your PATH.
npm install -g @realmkit/cliAuthentication required for this operation. Make sure you're logged in.
realmkit loginIf commands are timing out, check your internet connection and try again.
realmkit doctorExplore more CLI documentation and resources