Documentation/Installation

Installation Guide

Get the RealmKit CLI installed on your system in just a few minutes. Choose the installation method that works best for your environment.

Quick Install

Get started immediately with the recommended installation method

Run this command in your terminal:
npm install -g @realmkit/cli
Works on Windows, macOS, and Linux

System Requirements

Make sure your system meets these requirements before installing

Node.js
18.0.0 or higher
required
npm
8.0.0 or higher
required
Git
2.20.0 or higher
recommended
Docker
20.0.0 or higher
optional
Checking Requirements
You can check if you have the required software installed by running:
node --version
npm --version
git --version

Installation Methods

NPM (Recommended)

Install globally via npm package manager

Commands

npm install -g @realmkit/cli

Pros

  • Easy to install
  • Automatic updates
  • Cross-platform

Considerations

  • Requires Node.js

Yarn

Install globally via Yarn package manager

Commands

yarn global add @realmkit/cli

Pros

  • Fast installation
  • Good for Yarn users

Considerations

  • Requires Yarn setup

Direct Download

Download pre-built binaries

Commands

# Download for your platform
curl -L https://github.com/realmkitai/cli/releases/latest/download/realmkit-linux -o realmkit
chmod +x realmkit
sudo mv realmkit /usr/local/bin

Pros

  • No Node.js required
  • Self-contained

Considerations

  • Manual updates
  • Platform-specific

Verify Installation

Confirm that RealmKit CLI is installed and working correctly

Check Version

realmkit --version

This should display the installed version number.

Test CLI

realmkit list --limit=5

This should show a list of available realms.

Troubleshooting

Common installation issues and solutions

Command not found

If you get command not found: realmkit:

  • • Make sure npm's global bin directory is in your PATH
  • • Try running npm config get prefix
  • • Restart your terminal after installation

Permission errors

If you get permission errors during installation:

  • • Use sudo npm install -g @realmkit/cli on macOS/Linux
  • • Run terminal as Administrator on Windows
  • • Consider using a Node version manager like nvm

Next Steps

Now that you have RealmKit installed, here's what to do next

Quick Start Guide
Create your first project
CLI Reference
Learn all available commands
Browse Realms
Explore available templates
View on GitHub
Source code and issues