README
¶
Ω omega
omega is a terminal-based AI assistant that reads files, runs commands, and edits code. It talks to LLM providers (Ollama, OpenAI, Anthropic) and streams responses in real time. Single binary, full- screen TUI, persistent session tree, context compaction, and a pluggable extension system.
Warning: The shell tool executes commands the LLM generates with no sandboxing. Use Ollama for sensitive work — cloud providers receive file contents and command output.
Community
Join the Discord for release announcements and discussion.
Quick Start
git clone https://github.com/EndoTheDev/omega.git
cd omega
./build.sh # or build.bat on Windows
cp bin/config.yaml.example bin/config.yaml
# Edit bin/config.yaml: set provider type, model_name, api_key
bin/omega
Or install via go install:
go install github.com/EndoTheDev/omega/cmd/omega@latest
Architecture
gateway (HTTP API) -> agent (loop + tools) -> ai (provider streaming)
| Layer | Responsibility |
|---|---|
| Gateway | HTTP server, SSE streaming, session store |
| Agent | Multi-turn loop, tools, compaction, extensions |
| Provider | Ollama + OpenAI + Anthropic streaming |
| CLI | Entry point, TUI, trust gate, config |
See docs/architecture.md for details.
Extensions
All extensions are in-process Go packages under extensions/. See
extensions/README.md for the full list.
See docs/architecture.md for details.
Documentation
| Topic | File |
|---|---|
| Configuration | docs/configuration.md |
| Extensions | docs/extensions.md |
| TUI Commands | docs/tui.md |
| Project Trust | docs/project-trust.md |
| Architecture | docs/architecture.md |
| Roadmap | docs/roadmap.md |
| Troubleshooting | docs/troubleshooting.md |
License
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
omega
command
Command omega is the single binary entry point for the omega agent.
|
Command omega is the single binary entry point for the omega agent. |
|
extensions
|
|
|
compactor
Package compactor implements the compactor seam as an in-process plugin.
|
Package compactor implements the compactor seam as an in-process plugin. |
|
delegate
Package delegate provides the delegate.task and delegate.status tools.
|
Package delegate provides the delegate.task and delegate.status tools. |
|
http_channel
Package http_channel provides the HTTP/SSE delivery transport as a Channel extension.
|
Package http_channel provides the HTTP/SSE delivery transport as a Channel extension. |
|
logging
Package logging provides the logging seam (agent.LoggerProvider) backed by a file logger that writes to OMEGA_HOME/omega.log.
|
Package logging provides the logging seam (agent.LoggerProvider) backed by a file logger that writes to OMEGA_HOME/omega.log. |
|
mcp
Package mcp bridges MCP (Model Context Protocol) servers to omega.
|
Package mcp bridges MCP (Model Context Protocol) servers to omega. |
|
memory
Package memory provides the persistent memory seam (agent.MemoryProvider) backed by two markdown files (memory.md + user.md), plus the memory tool that lets the agent add, replace, and remove entries.
|
Package memory provides the persistent memory seam (agent.MemoryProvider) backed by two markdown files (memory.md + user.md), plus the memory tool that lets the agent add, replace, and remove entries. |
|
prompt
Package prompt builds the omega system prompt.
|
Package prompt builds the omega system prompt. |
|
provider
Package provider implements the provider seam for omega.
|
Package provider implements the provider seam for omega. |
|
skills
Package skills implements the skills seam: scanning a directory for <name>/<name>.md skill files, parsing YAML frontmatter, and providing the skills.read tool and /skills slash command.
|
Package skills implements the skills seam: scanning a directory for <name>/<name>.md skill files, parsing YAML frontmatter, and providing the skills.read tool and /skills slash command. |
|
store
Package store provides the session persistence seam (agent.StoreProvider) by wrapping gateway.Store (SQLite), plus the sessions.search tool that lets the agent search past conversations via FTS5.
|
Package store provides the session persistence seam (agent.StoreProvider) by wrapping gateway.Store (SQLite), plus the sessions.search tool that lets the agent search past conversations via FTS5. |
|
tools
Package tools provides the built-in shell and file tools as an in-process agent.ToolProvider.
|
Package tools provides the built-in shell and file tools as an in-process agent.ToolProvider. |
Click to show internal directories.
Click to hide internal directories.