Reading the repo

Opening the box…

How to set up rome (rome-os/rome) · gitmanual

Assembly instructions

rome-os/rome

A compounding agent OS for recursive agents. Also an open source alternative to Grok Bot and Meta's Muse.

Node.js#agent#agent-os#ai-agent#ai-assistant

Difficulty: Moderate
Time: about 15 min
Stars: ★ 890
Activity: Updated this month
License: MIT
Open issues: 290
Got it running: Be the first
Looked up: 10 h ago

Saved setup from 10 h ago

Start here

Website ↗romeos.ccThe project's own site.

Setup script in the repo

The maintainers included scripts/setup.sh. Run it from the cloned folder after reading it.

bash scripts/setup.sh

Will it work on my device?

Yes, it installs on your macOS

The README gives a install script install for macOS.

Checking for

Install with a package manager

install script

curl -fsSL https://raw.githubusercontent.com/rome-os/rome/main/scripts/quickstart-docker.sh | bash

Pipes a remote script into your shell. Read it before running.

From the README, exactly as the maintainers wrote it.

Did you get it running?

No reports for macOS yet.

Still stuck? Get a written guide

Claude reads the 15 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.

Parts list

1×Node.js >=24runtime
1×pnpm pnpm@11.6.0package manager

33× settings in .env

CLICKHOUSE_ENDPOINT
CLICKHOUSE_USERNAME
CLICKHOUSE_PASSWORDsecret
CLICKHOUSE_DATABASEoptional
MIDSCENE_MODEL_BASE_URL
MIDSCENE_MODEL_API_KEYsecret
MIDSCENE_MODEL_NAME
MIDSCENE_MODEL_FAMILY
ROME_E2E_BASE_URL
HEADLESS
ANTHROPIC_API_KEYsecretoptional
ROME_PROFILE
DATABASE_TYPE
WEB_PORT
WEB_HOST
ROME_JWT_SECRETsecret
STATSIG_SERVER_SECRET_KEYsecret
ROME_OAUTH_TOKEN_ENCRYPTION_KEYsecret
PANTHEON_BASE_ORIGIN
PANTHEON_DOMAIN
UPDATES_DOMAIN
PANTHEON_OAUTH_SERVICE_TOKENsecret
INTERNAL_API_PORT
INTERNAL_API_HOST
SSH_USER_PASSWORDsecretoptional
ROME_ENABLE_CDP_AUTOMATION
NEXT_PUBLIC_DESKTOP_DOWNLOAD_URL
STATSIG_CLIENT_KEYsecret
DOCKERHUB_USERNAME
DOCKERHUB_TOKENsecret
INTERNAL_API_WEBHOOK_API_KEYsecret
ROME_DOCKER_APP_CODE_MODE
ROME_HOST_EXECUTION_ENABLED

Share this manual

Is this your repo?

Add a badge to your README so newcomers find these steps.

[![Setup manual](https://gitmanual.com/rome-os/rome/badge.svg)](https://gitmanual.com/rome-os/rome)

Good to know

Monorepo (workspaces) — install from the repo root.
Dockerfile available (base image: node:24-slim).
Setup script found: scripts/setup.sh.
Has AGENTS.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.
Nested projects: example_apps/morning-brief/package.json, opencli-plugins/aa/package.json, opencli-plugins/chase/package.json, opencli-plugins/chatgpt/package.json and 11 more

package.json scripts (69)

startpnpm build:apps && pnpm --filter @rome/core start
devpnpm build:apps && pnpm --filter @rome/core dev
start:webpnpm --filter rome-web dev
start:web:mockpnpm --filter rome-web dev:mock
start:web:mock:e2epnpm --filter rome-web dev:mock:e2e
build:web:mockpnpm --filter rome-web build:mock
storybookpnpm --filter rome-web storybook
build:storybookpnpm --filter rome-web build:storybook
start:cdppnpm --filter rome-cdp-client start
dev:allscripts/dev-up.sh
dev:desktoppnpm --filter rome-desktop dev
dev:cdppnpm --filter rome-cdp-client dev
buildpnpm --filter @rome-os/node build && pnpm --filter @rome/discord-cli build && pnpm --filter @rome/signer build && pnpm --filter @rome/core build && pnpm build:apps && pnpm --filter rome-web build
build:docker-runtimepnpm --filter @rome-os/node build && pnpm --filter @rome/discord-cli build && pnpm --filter @rome/signer build && pnpm --filter @rome/core build && pnpm exec tsc -p tsconfig.scripts.build.json && node scripts/bundle-docker-core.mjs && pnpm obfuscate:docker-runtime && pnpm build:apps && pnpm --filter rome-web build
docker:runtime-workspacenode scripts/docker/prepare-runtime-workspace.mjs
docker:closure-checknode scripts/docker/check-runtime-closure.mjs
obfuscate:docker-runtimenode scripts/obfuscate-docker-runtime.mjs
preparehusky
typecheckpnpm -r typecheck
lintbiome check .
lint:fixbiome check --write .
lint:shscripts/lint-shell.sh
lint:prosenode scripts/check-prose.mjs
lint:agentstsx scripts/check-agents-symlinks.ts
lint:deadcodeknip --no-config-hints

Files we read (15)

.env.collector.example

.github/workflows/ci.yml

.github/workflows/dashboard-mock-deploy.yml

.github/workflows/desktop-build.yml

.github/workflows/desktop-publish-updates.yml

.github/workflows/docker-publish-test.yml

.github/workflows/mobile-ci.yml

DEVELOPMENT.md

Dockerfile

README.md

docker-compose.yml

package.json

packages/core/.env.example

pnpm-workspace.yaml

tests/midscene/.env.example

Branch main · 4,344 files in the repo