Getting started

Install the Rhodd binary, declare a system, and compile your first baseline.


Rhodd is a single Go binary — there is no npm package. Everything runs locally.

Install

bash
# install the rhodd compiler (Go binary — no npm)
sh install.sh --version v0.1.0-rc.1
# or
go install github.com/rhodd-fdn/rhodd-core/cmd/rhodd@v0.1.0-rc.1

The binary installs from rhodd-fdn/rhodd-core; the project lives at github.com/rhodd-fdn/rhodd.

Create a project

bash
mkdir my-system && cd my-system
rhodd init

rhodd init writes a starter rhodd.yaml you can edit.

Declare the system

rhodd.yaml is the declarative source of truth — services each with a kind, the modules they use, and how they're wired:

yaml
version: "0.1"
project:
  name: fullstack-saas
  description: Frontend, backend, worker, database, Docker, and Kubernetes.
backend:
  language: typescript
  framework: nest
  transport: rest
  orm: prisma
modules:
  - name: postgres
  - name: redis
services:
  - name: web
    kind: app
    runtime: react-ts-zod
    language: typescript
    port: 5173
    dependencies: [api]
  - name: api
    kind: app
    runtime: node-nest
    language: typescript
    port: 3000
    replicas: 2
infrastructure:
  compose: true

See System definition for the full field reference.

Compile

Run the stages in order — each is real, local and inspectable:

bash
rhodd validate     # check the definition against the schema and rules
rhodd generate     # emit the baseline + the .rhodd/ state directory
rhodd quality      # run the quality gates against the output

There is no compile command — the stages above are the compile.

Inspect

Everything Rhodd wrote is on disk:

bash
tree .rhodd
cat .rhodd.lock           # input/output hashes · rhodd@0.1.0 · reproducible: true
cat .rhodd/ai/context.md  # the handoff for humans and AI

That's the loop. Next: walk the whole thing in First compile path, or see what lands in Generated outputs.