Reference

What is Reference?

Reference is the section you come back to when you need stable facts while configuring, debugging, or operating OMX.

If the Guides section helps you choose a flow, the Reference section helps you answer questions like what is the exact filename, flag, variable, or precedence rule?

What can you find here?

Configuration

Configuration explains .codex/config.toml, .codex/hooks.json, and the main CLI flags.

This is the page to open when you need to know:

• where configuration lives
• how project-level settings relate to user-level settings
• what a specific launch flag means

Quick Commands

Quick Commands is the fastest place to look up common OMX commands.

This page is more about what to type right now than about deeper explanation.

Environment

Environment explains environment variables and runtime toggles.

For example:

• OPENAI_API_KEY
• OMX_OPENCLAW
• OMX_STATE_DIR

Migration

Migration covers upgrade notes and repository transition guidance.

Changelog

Changelog is where you look for release history and what actually shipped.

Contracts and .omx Directory

Contracts documents the behavioral contracts and guidance surfaces OMX tries to preserve. .omx Directory explains how OMX stores state, plans, notes, and wiki data on disk.

When should you read Reference first?

Reference is usually the fastest answer when:

• you need an exact config filename or location
• you are checking which flag or environment variable to use
• you want to know what something under .omx/ actually means
• you need stable rules and facts instead of a conceptual walkthrough

So when the question becomes “what exactly was that called?” or “where exactly does that live?”, Reference is usually the right section.