Getting Started en

中文 | English

Getting Started (5-Minute Quickstart)

Maintained version: v0.51.2 ｜ Last updated: 2026-07-06

This page walks you through cloning, building, testing, and running EnerOS in 5 minutes, with a /health check. For full setup see Installation. Source: README.md §Quick Start.

Prerequisites

• Rust 1.75+ (edition 2021)
• Linux recommended (Ubuntu 22.04+ / Debian 12+); Windows/macOS support core library development only
• Recommended: rustfmt / clippy / rust-src

rustup component add rustfmt clippy rust-src

Steps

# 1. Clone
git clone https://github.com/Gawg-AI/EnerOS.git eneros
cd eneros

# 2. Build (exclude eneros-installer on Windows/macOS)
cargo build --workspace --exclude eneros-installer

# 3. Test
cargo test --workspace

# 4. Run
cargo run --package eneros-api -- run --config eneros.toml

# 5. Health check (new terminal)
curl http://localhost:8080/health
# {"status":"ok","version":"0.51.2"}

Common Issues

Issue	Cause	Solution
eneros-installer build fails on Windows/macOS	HAL/seccomp/AF_PACKET not portable	Build with --exclude eneros-installer
Port 8080 already in use	Another process bound	Set ENEROS_API__PORT=9090
.sh scripts fail on Windows	Bash scripts	Use cargo run --package eneros-api -- run directly
libseccomp not found	Missing system library	apt install libseccomp-dev (Debian/Ubuntu)

Next Steps

• First Demo — enerosctl demo 7-step API walkthrough
• Architecture Overview — 11-layer architecture
• Configuration Reference — eneros.toml quick reference

Related Docs

• Main repo README.md §Quick Start
• Main repo docs/developer-guide.md §2 — Dev environment