Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
uah
command
Command uah is a general-purpose harness for unreal-agent-runner: long-lived sessions, a terminal UI, and headless runs built on uagent.
|
Command uah is a general-purpose harness for unreal-agent-runner: long-lived sessions, a terminal UI, and headless runs built on uagent. |
|
internal
|
|
|
agents
Package agents runs subagents: child sessions a session's agent spawns with the spawn_agent tool, following Codex's v1 multi-agent tools (see docs/design/subagents.md).
|
Package agents runs subagents: child sessions a session's agent spawns with the spawn_agent tool, following Codex's v1 multi-agent tools (see docs/design/subagents.md). |
|
app
Package app turns what the CLI collected into a session ready to open: Resolve decides the settings without I/O, and Setup loads the files and builds the engine around them.
|
Package app turns what the CLI collected into a session ready to open: Resolve decides the settings without I/O, and Setup loads the files and builds the engine around them. |
|
approval
Package approval decides how a command runs: in the sandbox, outside it, or not at all.
|
Package approval decides how a command runs: in the sandbox, outside it, or not at all. |
|
compaction
Package compaction rewrites a model request the way Codex compacts a thread: the user messages stay verbatim and in order (the newest 20,000 tokens of them), and everything else before a point is replaced by one summary message.
|
Package compaction rewrites a model request the way Codex compacts a thread: the user messages stay verbatim and in order (the newest 20,000 tokens of them), and everything else before a point is replaced by one summary message. |
|
config
Package config reads uah's configuration: a user file and, for workspaces the user trusts, a project file.
|
Package config reads uah's configuration: a user file and, for workspaces the user trusts, a project file. |
|
config/tomledit
Package tomledit edits TOML configuration files in place, keeping their comments and formatting: it sets or removes one key, or cuts whole tables, and writes the file atomically.
|
Package tomledit edits TOML configuration files in place, keeping their comments and formatting: it sets or removes one key, or cuts whole tables, and writes the file atomically. |
|
contextusage
Package contextusage breaks a model request into what fills the context window, as Claude Code's /context does: the system prompt, instruction files, skills, tools, MCP tools, and the conversation, with the free space and the auto-compaction buffer.
|
Package contextusage breaks a model request into what fills the context window, as Claude Code's /context does: the system prompt, instruction files, skills, tools, MCP tools, and the conversation, with the free space and the auto-compaction buffer. |
|
engine
Package engine abstracts how the harness drives unreal-agent-runner.
|
Package engine abstracts how the harness drives unreal-agent-runner. |
|
engine/codexauth
Package codexauth loads the ChatGPT subscription credentials the openai-codex provider sends: the access token and the account ID.
|
Package codexauth loads the ChatGPT subscription credentials the openai-codex provider sends: the access token and the account ID. |
|
engine/embedded
Package embedded is the engine that runs unreal-agent-runner's packages in process.
|
Package embedded is the engine that runs unreal-agent-runner's packages in process. |
|
engine/process
Package process is the engine that spawns unreal-agent-runner through uagent.
|
Package process is the engine that spawns unreal-agent-runner through uagent. |
|
engine/process/shellgate
Package shellgate applies the command rules to the process engine's commands.
|
Package shellgate applies the command rules to the process engine's commands. |
|
home
Package home is uah's one home, as Codex has ~/.codex and Claude Code has ~/.claude: the configuration, the instructions, hook trust, MCP credentials, sessions, run records, the index, images, the model cache, and logs all live in ~/.uah, or in $UAH_HOME when it is set.
|
Package home is uah's one home, as Codex has ~/.codex and Claude Code has ~/.claude: the configuration, the instructions, hook trust, MCP credentials, sessions, run records, the index, images, the model cache, and logs all live in ~/.uah, or in $UAH_HOME when it is set. |
|
home/migrate
Package migrate moves uah's files, once, from the folders it used before ~/.uah: the configuration directory (~/.config/uagent) and uah's part of the state directory it shared with uagent (~/.local/state/unreal-agent).
|
Package migrate moves uah's files, once, from the folders it used before ~/.uah: the configuration directory (~/.config/uagent) and uah's part of the state directory it shared with uagent (~/.local/state/unreal-agent). |
|
hooks
Package hooks runs user commands at session events, with Claude Code's contract: the event as JSON on stdin; exit 0 continues (optionally with JSON on stdout), exit 2 blocks with stderr as the reason, and any other exit is reported and ignored.
|
Package hooks runs user commands at session events, with Claude Code's contract: the event as JSON on stdin; exit 0 continues (optionally with JSON on stdout), exit 2 blocks with stderr as the reason, and any other exit is reported and ignored. |
|
images
Package images carries images pasted into the prompt.
|
Package images carries images pasted into the prompt. |
|
images/clipboard
Package clipboard reads an image from the system clipboard through the system's own tools, without cgo: osascript on macOS, and wl-paste or xclip on Linux.
|
Package clipboard reads an image from the system clipboard through the system's own tools, without cgo: osascript on macOS, and wl-paste or xclip on Linux. |
|
instructions
Package instructions finds instruction files (AGENTS.md, as Codex does) and builds the host prompt for the runner.
|
Package instructions finds instruction files (AGENTS.md, as Codex does) and builds the host prompt for the runner. |
|
llmcall
Package llmcall makes one model call outside the agent loop: items in, text out.
|
Package llmcall makes one model call outside the agent loop: items in, text out. |
|
mcp
Package mcp runs Model Context Protocol servers for the embedded engine: it starts the configured servers, lists their tools under Codex's names, and calls them.
|
Package mcp runs Model Context Protocol servers for the embedded engine: it starts the configured servers, lists their tools under Codex's names, and calls them. |
|
models
Package models is uah's model catalog: which models the provider offers to this login, with their context windows, reasoning levels, and service tiers.
|
Package models is uah's model catalog: which models the provider offers to this login, with their context windows, reasoning levels, and service tiers. |
|
models/modelstest
Package modelstest serves model catalogs to tests without the network.
|
Package modelstest serves model catalogs to tests without the network. |
|
patch
Package patch parses and applies Codex's apply_patch format, and computes the diff of what a patch changed.
|
Package patch parses and applies Codex's apply_patch format, and computes the diff of what a patch changed. |
|
review
Package review is the automatic approval reviewer, Codex's "auto-review" (guardian): one model call judges an action that needs approval, from the user's messages (trusted), the recent tool calls without their output (untrusted), and the action itself.
|
Package review is the automatic approval reviewer, Codex's "auto-review" (guardian): one model call judges an action that needs approval, from the user's messages (trusted), the recent tool calls without their output (untrusted), and the action itself. |
|
rules
Package rules is Codex's command rules: `prefix_rule` entries in Starlark `.rules` files, matched against a command's words, with the strictest matching decision winning.
|
Package rules is Codex's command rules: `prefix_rule` entries in Starlark `.rules` files, matched against a command's words, with the strictest matching decision winning. |
|
sandbox
Package sandbox runs shell commands inside the operating system's sandbox, as Codex does: Seatbelt (sandbox-exec) on macOS and bubblewrap on Linux.
|
Package sandbox runs shell commands inside the operating system's sandbox, as Codex does: Seatbelt (sandbox-exec) on macOS and bubblewrap on Linux. |
|
session
Package session is the long-lived object the TUI and `uah run` talk to.
|
Package session is the long-lived object the TUI and `uah run` talk to. |
|
store
Package store keeps a rebuildable SQLite index of the run records in the state directory, so listing, searching, and activity do not reread every summary (docs/design/state.md).
|
Package store keeps a rebuildable SQLite index of the run records in the state directory, so listing, searching, and activity do not reread every summary (docs/design/state.md). |
|
tui/bubble
Package bubble is the Bubble Tea shell around the TUI state and renderer: it turns keys into intents, runs effects against the session, batches session events, and draws frames.
|
Package bubble is the Bubble Tea shell around the TUI state and renderer: it turns keys into intents, runs effects against the session, batches session events, and draws frames. |
|
tui/render
Package render draws TUI state as screen lines with lipgloss.
|
Package render draws TUI state as screen lines with lipgloss. |
|
tui/render/markdown
Package markdown draws the Markdown the model writes as terminal lines, in uah's look after Codex's: goldmark parses it with the GFM extensions, and a renderer of its own walks the tree.
|
Package markdown draws the Markdown the model writes as terminal lines, in uah's look after Codex's: goldmark parses it with the GFM extensions, and a renderer of its own walks the tree. |
|
tui/state
Package state is the TUI's model and reducer.
|
Package state is the TUI's model and reducer. |
|
usage
Package usage reads the ChatGPT subscription's rate limits for the openai-codex provider, as Codex does: the windows (for example 5 hours and a week), the percent used, and when each resets.
|
Package usage reads the ChatGPT subscription's rate limits for the openai-codex provider, as Codex does: the windows (for example 5 hours and a week), the percent used, and when each resets. |
|
usershell
Package usershell runs a command the user types in the TUI's shell mode (`!` in the composer), as Codex's user shell commands and Claude Code's bash mode do, and writes the record the agent sees of it.
|
Package usershell runs a command the user types in the TUI's shell mode (`!` in the composer), as Codex's user shell commands and Claude Code's bash mode do, and writes the record the agent sees of it. |
|
testing
|
|
|
fakellm
Package fakellm is a scripted OpenAI Responses API for tests.
|
Package fakellm is a scripted OpenAI Responses API for tests. |
|
harnesstest
Package harnesstest sets up isolated uagent environments for tests: the fake runner from uagent, a workspace, a state directory, and Codex credentials that pass preflight.
|
Package harnesstest sets up isolated uagent environments for tests: the fake runner from uagent, a workspace, a state directory, and Codex credentials that pass preflight. |
|
mcpserver
command
Command mcpserver is a stdio MCP server for tests, built with the official Go SDK.
|
Command mcpserver is a stdio MCP server for tests, built with the official Go SDK. |
|
oauthserver
Package oauthserver is an MCP server behind OAuth 2.1 for tests, in one httptest server: the protected resource (/mcp, a streamable HTTP MCP server built with the official SDK, with a whoami tool), its protected resource metadata, and a small authorization server with dynamic client registration, PKCE (S256), and refresh tokens.
|
Package oauthserver is an MCP server behind OAuth 2.1 for tests, in one httptest server: the protected resource (/mcp, a streamable HTTP MCP server built with the official SDK, with a whoami tool), its protected resource metadata, and a small authorization server with dynamic client registration, PKCE (S256), and refresh tokens. |
Click to show internal directories.
Click to hide internal directories.
