Getting started

This page is the on-ramp: install the toolchain, create or adopt a project, then follow the learning path in the sidebar (same idea as Flutter documentation — start here, then branch by topic).

---

1. Install the toolchain

A. Global CLI (so omega is available everywhere):

dart pub global activate omega_architecture

Bleeding edge from Git:

dart pub global activate --source git https://github.com/yefersonSegura/omega_architecture.git

Add Pub’s bin to your PATH:

OS	Typical path
Windows	%LOCALAPPDATA%\Pub\Cache\bin → e.g. C:\Users\<you>\AppData\Local\Pub\Cache\bin
macOS / Linux	$HOME/.pub-cache/bin

Verify:

omega --help

If the shell cannot find omega, use dart run omega_architecture:omega … from a project that lists the package in pubspec.yaml, or invoke omega.bat by full path on Windows. Pub does not support dart pub global run for Flutter-dependent globals — see the README for details.

---

2. New application

omega create app my_app
cd my_app && flutter run

Optional AI kickstart (requires env + keys):

omega create app my_store --kickstart "e-commerce with cart" --provider-api

---

3. Existing Flutter app

Add the dependency (pick the current version on pub.dev):

dependencies:
  omega_architecture: ^1.0.5

From the app root:

dart run omega_architecture:omega init

Then align lib/omega/omega_setup.dart with your modules — see omega_setup.dart and the example/ tree on GitHub.

---

4. Learning path (recommended order)

Step	Guide	Why
1	Vision & why Omega	Fit and trade-offs
2	Core concepts	Glossary
3	Data flow	End-to-end path
4	Total architecture	One map of the whole stack
5	omega_setup.dart	Composition + cold start
6	Channel & events → Intents & flows → Agents	Core library
7	Navigation & routes	navigate.* and typed routes
8	Omega CLI	Every command + omega ai
9	Inspector	Debug UX
10	Testing	Tests without heavy UI
11	Contracts / Time travel / Offline-first	Advanced topics
12	Comparison	vs BLoC / Riverpod

---

5. API reference

Generated API docs live on pub.dev: omega_architecture API.

The API reference page in this site explains how to navigate them.