Quick Start

If you only want the shortest path to a working setup, start with Get Working Fast. This quick start is broader — it assumes you want both a first success and a light tour of the interface.

1. Install & authenticate

curl -fsSL https://omegon.styrene.dev/install.sh | sh
omegon login openai-codex   # or: export ANTHROPIC_API_KEY="sk-ant-..."
omegon

You will see the splash screen, then the TUI opens with the conversation view in the center, the editor at the bottom, and the status footer below it.

2. Your first prompt

Type a prompt and press Enter:

Read README.md and summarize the project structure

The agent will call the read tool, show the file contents in a tool card, and respond with a summary.

3. Read the footer honestly

RowWhat It Means
providerConcrete runtime provider identity, such as OpenAI/Codex or Anthropic/Claude
modelSelected runtime model, such as gpt-5.4
limitProvider quota telemetry or bucket metadata when the upstream exposes it
stateContext class, fill percentage, and window size
sessionTurns and cumulative session token counts

That distinction matters. The limit row is provider telemetry, not a second model selector.

4. Key commands

/model         # Switch model (opens selector)
/think high    # Raise reasoning effort
/context clan  # Raise context class
/status        # Check provider and system status
/tutorial      # Launch the interactive overlay tutorial
/update        # Inspect and install a newer release

5. Project memory

Omegon persists durable project facts across sessions. In a fresh repo, start with:

/init

The agent will orient itself to the project, store foundational facts, and carry that memory into future sessions.

6. Multi-file changes

For substantial work, Omegon can assess complexity and decompose it into parallel worktree children:

Refactor the auth module to support OAuth2 PKCE flow

# If warranted, Omegon will recommend /cleave.
# You can also trigger it explicitly:
/cleave

7. Browser surfaces

/auspex open

Launches Omegon's primary browser surface. If the local compatibility bridge is not running yet, Omegon starts it first. For direct local compatibility/debug access, /dash remains available.

8. Tutorial

/tutorial is not a fake tour. It is an interactive overlay that can read code, store memory, and create lifecycle artifacts in your real project.

/tutorial        # current-project path
/tutorial demo   # scripted showcase path

Next steps