okami.mom/albedo

git clone https://git.nkp.pet/okami.mom/albedo

Aly Raffaufdocs(api): generate a searchable OpenAPI reference70a2db3

main
1.8 KiB21 linesraw

Overview

Albedo is an agentic coding harness that can act on your device and soon able to manage sessions on other devices with agents that can act remotely on different machines or within containers. Our hope is that it being built on BEAM allows it to maintain low memory usage while running many concurrent agents and subagents across devices.

Albedo is daemonized with the CLI and (future) WebUI being clients of this daemon. This ensures the agents can be programatically created, controlled, and even stopped all while still providing an experience similar to other harnesses like Claude Code and Codex. Albedo provides a Python REPL for the agents to use as a scratchpad and data manipulation allowing them to experiment, reason, and play with code before actually writing it down. This is similar to what other harnesses call CodeMode and is based on prime-agent's's Python REPL and design.

Daemon attachment and local startup explains how clients discover, attach to, start, and explicitly restart a daemon.

Client API ownership explains how named operations separate daemon requests from application commands and TUI screens.

HTTP API design defines protocol 3, resource contracts, SSE recovery, extension routes, and existing TUI feature coverage. OpenAPI contract defines the exact request, response, and stream payload shapes for that API. Generate a searchable HTML reference with python3 scripts/api-reference.py from the repository root, then open docs/api-reference.html in a browser. The page embeds the current contract and loads Scalar 1.72.4 from a CDN, so viewing it requires an internet connection. Generated HTML is ignored by Git. API architecture explains state ownership and crash recovery.

1# Overview
2Albedo is an agentic coding harness that can act on your device and soon able to manage sessions on other devices with agents that can act remotely on different machines or within containers. Our hope is that it being built on BEAM allows it to maintain low memory usage while running many concurrent agents and subagents across devices.
3
4Albedo is daemonized with the CLI and (future) WebUI being clients of this daemon. This ensures the agents can be programatically created, controlled, and even stopped all while still providing an experience similar to other harnesses like Claude Code and Codex. Albedo provides a Python REPL for the agents to use as a scratchpad and data manipulation allowing them to experiment, reason, and play with code before actually writing it down. This is similar to what other harnesses call CodeMode and is based on [prime-agent's](https://github.com/PrimeIntellect-ai/prime-agent/)'s Python REPL and design.
5
6[Daemon attachment and local startup](daemon-lifecycle.md) explains how clients
7discover, attach to, start, and explicitly restart a daemon.
8
9[Client API ownership](client-api.md) explains how named operations separate
10daemon requests from application commands and TUI screens.
11
12[HTTP API design](http-api-design.md) defines protocol 3, resource
13contracts, SSE recovery, extension routes, and existing TUI feature coverage.
14[OpenAPI contract](openapi.yaml) defines the exact request, response, and stream
15payload shapes for that API.
16Generate a searchable HTML reference with `python3 scripts/api-reference.py`
17from the repository root, then open `docs/api-reference.html` in a browser.
18The page embeds the current contract and loads Scalar 1.72.4 from a CDN,
19so viewing it requires an internet connection. Generated HTML is ignored by Git.
20[API architecture](http-api-architecture.md) explains state ownership and crash
21recovery.