Welcome to Holium Docs
Upload Pier with SFTP
Requirements for Realm
Download and Setup Realm
A Tour of Realm
Common fixes for issues
Notifications & Settings
Realm is a desktop environment for Urbit.
We use yarn workspace to manage the multiple modules.
- app/ the Realm desktop client
- onboarding/ the web onboarding flow
- shared/ shared code in the monorepo
- lib/ outwards facing packages that are published to npmjs.com
- design-system/ component library for Realm apps
- presence/ cursor streaming for Realm apps
We use yarn workspaces to build all packages for Realm.
# Install dependencies and build all packages
# Note: you may have to rebuild sqlite3
# Start the app
to setup fakeships and pull the Urbit submodule down into the Realm repo.
Once these ships are created, you can then go to
to get started with Realm.
Linux Installation Notes
Realm is distributed as an AppImage file. AppImages require FUSE version 2 to run. If you are running Ubuntu (>= 22.04), you will need to install fuse version 2. More information here:
Build prerelease version
npx cross-env DEBUG_PROD=true yarn package:prerelease:mac
npx cross-env DEBUG_PROD=true yarn package:prerelease:linux
npx cross-env DEBUG_PROD=true yarn package:prerelease:win
Building a prerelease will replace the
files in all the
folders, so make sure to run
rm -rf ./**/dist
in root when you want to run Realm in dev mode again.
For frontend development, make sure to:
Install the ESLint extension in your editor of choice (
). The Prettier extension is not needed since we're using it as an ESLint plugin.
Configure your editor to format on save, so you don't have to run
Follow the Frontend Style Guide.
For Developers - Previous