Getting started

This topic walks through installing the package, scaffolding with ng add, and where to read next — similar in purpose to Angular’s Getting started flow for a new workspace.

New to Omega?

If you are still evaluating fit and trade-offs, read Vision & why Omega or the short Overview before restructuring your app.

Prerequisites

• Angular CLI workspace (see Angular documentation — Local setup for the current recommended versions).
• Node.js and npm compatible with your Angular version.

Install

npm install omega-angular

New application

ng new my-app --defaults
cd my-app
ng add omega-angular

ng add omega-angular configures ESLint-first build / serve, optional omega-setup.ts with a login + home starter (unless --minimal), and merges providers into app.config.ts.

To undo that wiring (builders, ESLint config, providers, optionally omega-setup.ts), use ng generate omega-angular:remove then npm uninstall omega-angular — see Schematics.

Use the primitives

• Register provideOmega() (usually from omega-setup.ts).
• Define flows (OmegaFlow) and agents (OmegaAgent) for your domain.
• Send intents with OmegaFlowManager.handleIntent and events via OmegaChannel.

Learn the runtime

1. What Omega solves — pain points and how the library answers them
2. Cookbook — step-by-step code recipes (auth-style flow)
3. Core concepts — glossary and diagram
4. Data flow — intents → flows → channel → agents
5. Channel & events, Intents & flows, Agents
6. Wire names & feature layout — AuthWire-style tables and folders
7. Testing — unit-test the channel and flows
8. Navigation & Router — bridge pattern with Router
9. API reference — package exports

Repository layout (example)

Feature folders often look like:

src/app/my-feature/
├── services/   # HttpClient / APIs only
├── models/
├── omega/      # flow, behavior, agent, constants
└── views/      # components

Global bootstrap stays in omega-setup.ts (flows, agents, router bridge).

Full README

The canonical developer guide for this monorepo lives in the GitHub repository README.

What’s next

Step	Topic
Mental model	Core concepts
End-to-end path	Data flow
Bootstrap file	omega-setup.ts
Public exports	API reference