Getting Started

Quick start with npx

If you want the shortest path to a working Enrai instance:

npx enrai@latest start

This launches Enrai with the portable flow and serves the editor from the backend.

If you want to load a local config file:

npx enrai@latest start --config ./enrai.config.json

Requirements

• Node.js 22 or newer is required for the full Enrai toolchain.
• npm is used throughout this repository.
• macOS, Linux, or WSL is recommended for PTY support.

Install dependencies

From the repository root:

npm install
cd backend && npm install
cd ../documentation && npm install

Run the main workspace

Frontend:

npm run dev

Backend:

cd backend
npm run dev

Default local URLs:

• Frontend: http://localhost:3000/editor
• Backend: http://localhost:3001

Run the documentation site

cd documentation
npm run dev

Default local URL:

• Docs: http://localhost:3000/docs

If your main editor app is already using port 3000, Next will pick the next available port automatically.

Portable mode

You can also serve the frontend from the backend:

npm run build:portable
npm run start:portable

Portable URL:

• http://localhost:3001/editor

Screenshot checklist

Main workspace

Use this as the first product screenshot. It should explain the editor in one glance.

Drop replacement PNG here

Replace documentation/public/images/editor-main-workspace.png and the docs will update without changing this page.

• Left activity bar visible
• File explorer open with folders collapsed cleanly
• 2 or 3 file tabs open
• A real code file visible in Monaco
• Terminal open at the bottom with useful output

documentation/public/images/editor-main-workspace.png