README
¶
Coding
Coding is the product built on the reusable agent and llm libraries. Its
packages are product implementation details and are not a public SDK.
Coding and the Go packages use the same version.
Layout
coding/
├── client/ React client
├── desktop/ Electron desktop shell
├── cmd/coding/ Standalone API entry point
└── internal/
├── app/ Composition root and process startup
├── engine/ One stateful coding-agent session
├── conversation/ Product conversation lifecycle and queueing
├── httpapi/ HTTP and SSE delivery
├── transcript/ Transcript model and persistence
├── compaction/ Context compaction
├── permission/ Tool-call approval policy
├── prompt/ Coding system prompt
├── skills/ Skill discovery and loading
├── tools/ Coding tools and local execution
├── provider/ Provider settings
├── workspace/ Workspace registry and scratch directories
├── usage/ Usage ledger
└── config/ Process startup configuration
Dependency direction
client -> HTTP/SSE -> httpapi -> conversation -> engine -> agent -> llm
^ |
| +-> coding product packages
+--- app creates and connects all services
Both cmd/coding and desktop host the reusable runtime assembled by
internal/app. Product policy stays inside coding; agent and llm must not
import it. Coding must not depend on harness.
Desktop
Electron supervises a dedicated Go sidecar on a random loopback port. The
sidecar serves both the React build and /api, so browser and desktop clients
keep the same relative HTTP/SSE contract. Every request requires a per-launch
HttpOnly session cookie installed by Electron before the first navigation.
The right-side Browser is rendered with Electron <webview> elements. React
owns their layout and tab lifecycle, so menus and dialogs can compose above a
page without hiding a separate native child view. A renderer-side registry owns
navigation revisions, history state, failure reporting, and bounded read-only
inspection.
Public HTTP(S), localhost, and workspace preview pages currently share the desktop session. Dedicated webview partitions, workspace request isolation, permission policy, and attach-time validation remain required before treating untrusted workspace content as isolated.
Run the desktop app in development:
cd coding/desktop
bun install
bun run dev
Build an unpacked application for the current platform:
cd coding/desktop
bun run package:dir
Use the following command to create ad-hoc signed macOS distributables under
coding/desktop/release:
bun run package -- --mac --publish never \
--config.mac.identity=- \
--config.mac.hardenedRuntime=false
Repository vX.Y.Z tags build Apple Silicon and Intel Mac installers. See
RELEASING.md.
The desktop and standalone shells share provider settings, sessions and
transcripts under ~/.or/coding. Set OR_DATA_DIR to use another location.
The desktop shell is single-instance: launching it again restores and focuses
the existing window.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
coding
command
Command coding starts the product API consumed by the separate client.
|
Command coding starts the product API consumed by the separate client. |
|
coding-desktop
command
Command coding-desktop runs the authenticated loopback server supervised by the Electron main process.
|
Command coding-desktop runs the authenticated loopback server supervised by the Electron main process. |
|
internal
|
|
|
capability
Package capability assembles optional coding-product behavior around the reusable agent SDK.
|
Package capability assembles optional coding-product behavior around the reusable agent SDK. |
|
compaction
Package compaction prepares and summarizes old coding-session context.
|
Package compaction prepares and summarizes old coding-session context. |
|
config
Package config resolves product-shell settings.
|
Package config resolves product-shell settings. |
|
desktopserver
Package desktopserver serves the Electron renderer and product API from one authenticated loopback origin.
|
Package desktopserver serves the Electron renderer and product API from one authenticated loopback origin. |
|
engine
Package engine owns one stateful coding-agent session.
|
Package engine owns one stateful coding-agent session. |
|
httpapi
Package httpapi is the product's HTTP delivery layer.
|
Package httpapi is the product's HTTP delivery layer. |
|
httpapi/internal/genwire
command
Command genwire generates the browser's TypeScript wire DTOs from the Go structs and string enums in wire_contract.go.
|
Command genwire generates the browser's TypeScript wire DTOs from the Go structs and string enums in wire_contract.go. |
|
modelcontext
Package modelcontext owns product-generated context projected into model requests without adding fake user messages to the agent's canonical transcript.
|
Package modelcontext owns product-generated context projected into model requests without adding fake user messages to the agent's canonical transcript. |
|
permission
Package permission owns the coding product's tool authorization policy.
|
Package permission owns the coding product's tool authorization policy. |
|
plugin
Package plugin defines the transport-neutral contract between Coding and one external capability process.
|
Package plugin defines the transport-neutral contract between Coding and one external capability process. |
|
prompt
Package prompt deterministically renders the coding agent's stable system prompt, discovers the instruction files and environment that make up its dynamic context, and renders those as model-visible attachments.
|
Package prompt deterministically renders the coding agent's stable system prompt, discovers the instruction files and environment that make up its dynamic context, and renders those as model-visible attachments. |
|
provider
Package provider manages the coding product's persisted provider connection profiles.
|
Package provider manages the coding product's persisted provider connection profiles. |
|
skills
Package skills loads file-backed skills and exposes them to a coding agent.
|
Package skills loads file-backed skills and exposes them to a coding agent. |
|
titlegen
Package titlegen generates short product-facing session titles through the independently configured utility-model route.
|
Package titlegen generates short product-facing session titles through the independently configured utility-model route. |
|
tools
Package tools implements the coding agent's built-in tools: file reading, editing, writing, and shell execution.
|
Package tools implements the coding agent's built-in tools: file reading, editing, writing, and shell execution. |
|
transcript
Package transcript defines the durable, append-only history of a coding session.
|
Package transcript defines the durable, append-only history of a coding session. |
|
usage
Package usage is the coding product's token and cost ledger.
|
Package usage is the coding product's token and cost ledger. |
|
workspace
Package workspace owns the directories a coding session runs in: the project roots a user registers, and the scratch directories the server generates for standalone chats.
|
Package workspace owns the directories a coding session runs in: the project roots a user registers, and the scratch directories the server generates for standalone chats. |