Quickstart Guide

Learn how to install the Omera CLI, initialize your workspace, and run your first hardware schematic netlist analysis in under 5 minutes.

System Requirements

Before installing, ensure your development machine meets the following prerequisites:

• Python 3.10+ and pip (latest version)
• PlatformIO Core (for compiling/building firmware)
• pyOCD (for on-chip flashing and hardware debugging)
• Compatible hardware debug probe (ST-Link, J-Link, or CMSIS-DAP)

Installation

Omera CLI is distributed as a Python package. We recommend installing it in a virtual environment:

# Create and activate virtual environment
python -m venv .venv
source .venv/bin/activate  # On Windows use: .venv\Scripts\activate

# Install Omera CLI
pip install @omeraeda/cli

# Verify installation
omera version

The version output will verify the environment, Python runtime, and Omera 3.6 engine activation:

Omera CLI   v0.14.2
Python      3.11.9
Platform    linux-x86_64
Engine      Omera 3.6

Tip: Always run omera doctor immediately after installation to verify toolchains, AI connectivity, and sandbox permissions.

First-Time Workspace Initialization

To start a new project or configure an existing directory for Omera:

# Create project directory
mkdir smart-sensor-node && cd smart-sensor-node

# Initialize Omera workspace
omera init

This command creates a hidden directory .omera/ which manages workspace configurations, AI logs, and build artifacts:

• .omera/config.json: Project settings (target board, active netlist).
• .omera/runs/: History of all pipeline executions.
• .omera/deliveries/: Package folder containing evidence zip archives.

Run the Humidifier Demo

Omera includes built-in reference designs. You can generate a golden demo project using:

omera demo mha

This generates the schematic netlist and app logic spec for a Multi-Humidity Actuator (MHA) board, setting up the complete environment to test Omera's generation capabilities.

Running the Core Workflow Pipeline

To run the full C1–C5 hardware-to-firmware generation and compilation pipeline, run:

omera fw workflow run --input board.net --board-id STM32F407VG --out output/

The workflow proceeds through 5 distinct pipeline stages:

1. C1: Ingestion & Normalization: Parses KiCad or Altium netlists to register MCU ports and connected ICs.
2. C2: Safety Evaluation: Validates safety-critical actuator lines and locks down forbidden pin states.
3. C3: Driver Resolution: Resolves HAL drivers and dependencies for every IC on the board.
4. C4: Firmware Initialization Plan: Designs the architecture plan of tasks, drivers, and safety pins.
5. C5: Build & Verify: Invokes PlatformIO compiler and executes static code analysis.

Interactive AI chat (REPL)

Initiate a multi-turn chat session with Omera 3.6 for direct code edits or troubleshooting:

omera chat

Type /help inside the REPL to list all available slash commands for managing sessions and compacting token context.