Install the RealmKit CLI globally
npm install -g @realmkit/cliAfter installation, you can verify it's working by running:
realmkit --versionOptions available for all commands
--help, -hShow help information--version, -vShow version number--verboseEnable verbose output--quiet, -qSuppress output--configPath to config filerealmkit createCreate a new project from a realm template
realmkit create <realm-name> [project-name] [options]realmkit create saas-starter my-apprealmkit create nextjs-blog --typescriptrealmkit create api-template backend --git--typescriptUse TypeScript variant if available--gitInitialize git repository--installAutomatically install dependenciesrealmkit searchSearch for realm templates
realmkit search [query] [options]realmkit search saasrealmkit search --category=apirealmkit search nextjs --tags=typescript--categoryFilter by category--tagsFilter by tags--limitLimit number of resultsrealmkit publishPublish your realm to the hub
realmkit publish [options]realmkit publishrealmkit publish --name="My Realm" --category=saasrealmkit publish --dry-run--nameRealm name--descriptionRealm description--categoryRealm category--dry-runPreview without publishingrealmkit listList available realms
realmkit list [options]realmkit listrealmkit list --featuredrealmkit list --category=web--featuredShow only featured realms--categoryFilter by category--formatOutput format (table, json)realmkit infoGet detailed information about a realm
realmkit info <realm-name>realmkit info saas-starterrealmkit info nextjs-blog --json--jsonOutput as JSONrealmkit configManage RealmKit configuration
realmkit config <subcommand> [options]realmkit config set api-key YOUR_KEYrealmkit config getrealmkit config reset--globalUse global configurationRealmKit CLI configuration options
The CLI looks for configuration in the following locations:
~/.realmkit/config.json (global)./.realmkit.json (project-specific)REALMKIT_{
"apiKey": "your-api-key",
"registry": "https://registry.realmkit.com",
"defaultCategory": "web",
"autoInstall": true,
"git": {
"autoInit": true,
"defaultBranch": "main"
}
}