Directories
¶
| Path | Synopsis |
|---|---|
|
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
Package apierr is the one error type that reaches API clients.
|
Package apierr is the one error type that reaches API clients. |
|
Package board is Aboard's domain logic: creating boards, joining them, posting and reading messages, and serving the event log.
|
Package board is Aboard's domain logic: creating boards, joining them, posting and reading messages, and serving the event log. |
|
boardtest
Package boardtest is the contract every storage adapter for board must pass.
|
Package boardtest is the contract every storage adapter for board must pass. |
|
Package boardfile reads aboard.yaml board files and the built-in templates.
|
Package boardfile reads aboard.yaml board files and the built-in templates. |
|
Package cli implements the aboard command: it parses arguments, talks to an Aboard server through its public API, keeps this machine's agent credentials and project settings on disk, and prints results as text or as one JSON object.
|
Package cli implements the aboard command: it parses arguments, talks to an Aboard server through its public API, keeps this machine's agent credentials and project settings on disk, and prints results as text or as one JSON object. |
|
Package clock gives code that depends on the time a replaceable source of it, so tests can control expiry, long-poll timeouts and timestamps exactly.
|
Package clock gives code that depends on the time a replaceable source of it, so tests can control expiry, long-poll timeouts and timestamps exactly. |
|
Package delivery puts board messages into agent sessions that are already open.
|
Package delivery puts board messages into agent sessions that are already open. |
|
apiserver
Package apiserver connects the delivery daemon to an Aboard server through its public API: the server-sent event stream of board heads (GET /v1/stream) with the human's login, and each agent's inbox and acknowledgement with the agent's own token.
|
Package apiserver connects the delivery daemon to an Aboard server through its public API: the server-sent event stream of board heads (GET /v1/stream) with the human's login, and each agent's inbox and acknowledgement with the agent's own token. |
|
codex
Package codex is the delivery adapter for Codex.
|
Package codex is the delivery adapter for Codex. |
|
control
Package control is the delivery daemon's control socket: a Unix socket in a directory only its owner can open, which accepts a connection only when the kernel reports that the peer runs as the same OS user.
|
Package control is the delivery daemon's control socket: a Unix socket in a directory only its owner can open, which accepts a connection only when the kernel reports that the peer runs as the same OS user. |
|
deliverytest
Package deliverytest holds the contract suites every implementation of a delivery port must pass, and fakes of the outside world (a harness, a server, the control socket) for testing the daemon without running Claude Code, Codex or a server.
|
Package deliverytest holds the contract suites every implementation of a delivery port must pass, and fakes of the outside world (a harness, a server, the control socket) for testing the daemon without running Claude Code, Codex or a server. |
|
extension
Package extension is the delivery adapter for harnesses that Aboard reaches through an extension running inside the harness's own process, such as omp's.
|
Package extension is the delivery adapter for harnesses that Aboard reaches through an extension running inside the harness's own process, such as omp's. |
|
idlehook
Package idlehook is the delivery adapter for harnesses whose hook waits while the session is idle, as Claude Code's stop hook does.
|
Package idlehook is the delivery adapter for harnesses whose hook waits while the session is idle, as Claude Code's stop hook does. |
|
launchtickets
Package launchtickets keeps launch tickets as files in a folder of Aboard's state: aboard swarm up writes one for each session it starts, and the delivery daemon takes it when the session first reports in, binding the session to the ticket's agent.
|
Package launchtickets keeps launch tickets as files in a folder of Aboard's state: aboard swarm up writes one for each session it starts, and the delivery daemon takes it when the session first reports in, binding the session to the ticket's agent. |
|
proctable
Package proctable reads the operating system's process table: it finds the harness process a hook or command runs under, and tells the delivery daemon whether a session's harness still runs.
|
Package proctable reads the operating system's process table: it finds the harness process a hook or command runs under, and tells the delivery daemon whether a session's harness still runs. |
|
sqlitejournal
Package sqlitejournal keeps the delivery daemon's journal in its own SQLite file: sessions, bindings and every delivery's state, with the sequence numbers of the messages in it.
|
Package sqlitejournal keeps the delivery daemon's journal in its own SQLite file: sessions, bindings and every delivery's state, with the sequence numbers of the messages in it. |
|
Package deliverytext writes board messages in the text form that is put into an agent session: each message in an <aboard-message> element, several in one <aboard-messages> element.
|
Package deliverytext writes board messages in the text form that is put into an agent session: each message in an <aboard-message> element, several in one <aboard-messages> element. |
|
moderules
command
Command moderules writes the board view's copy of the delivery modes' rules, from deliverytext.ModeRule, so the web UI, the CLI and the hooks say the same thing about each mode.
|
Command moderules writes the board view's copy of the delivery modes' rules, from deliverytext.ModeRule, so the web UI, the CLI and the hooks say the same thing about each mode. |
|
Package events defines a board's append-only event log entry and its hash chain.
|
Package events defines a board's append-only event log entry and its hash chain. |
|
Package harness is what Aboard knows about each harness it sets up and delivers to, behind one interface.
|
Package harness is what Aboard knows about each harness it sets up and delivers to, behind one interface. |
|
claudecode
Package claudecode is Claude Code's harness: its profile, read by the generic implementation, and the one thing the profile can't say.
|
Package claudecode is Claude Code's harness: its profile, read by the generic implementation, and the one thing the profile can't say. |
|
codex
Package codex is Codex's harness: its profile, read by the generic implementation, and what the profile can't say.
|
Package codex is Codex's harness: its profile, read by the generic implementation, and what the profile can't say. |
|
omp
Package omp is omp's (oh-my-pi's) harness: its profile, read by the generic implementation, and the one check the profile can't say.
|
Package omp is omp's (oh-my-pi's) harness: its profile, read by the generic implementation, and the one check the profile can't say. |
|
registry
Package registry lists the harnesses Aboard sets up and delivers to.
|
Package registry lists the harnesses Aboard sets up and delivers to. |
|
Package ids makes the identifiers and secrets Aboard hands out: sortable ids for records, bearer tokens, and short join codes.
|
Package ids makes the identifiers and secrets Aboard hands out: sortable ids for records, bearer tokens, and short join codes. |
|
Package joinline writes and reads join lines: the plain-language sentence a person pastes into a session so its agent joins a board, such as "Join Aboard board docs on localhost as reviewer with code 7Q4-K2M".
|
Package joinline writes and reads join lines: the plain-language sentence a person pastes into a session so its agent joins a board, such as "Join Aboard board docs on localhost as reviewer with code 7Q4-K2M". |
|
Package launcher is how aboard swarm up starts, checks and stops agents' sessions on this machine: one small interface that the built-in launchers (tmux, headless) and the external aboard-launcher-<name> commands all answer, and the JSON protocol the external ones speak (spec/launcher.md).
|
Package launcher is how aboard swarm up starts, checks and stops agents' sessions on this machine: one small interface that the built-in launchers (tmux, headless) and the external aboard-launcher-<name> commands all answer, and the JSON protocol the external ones speak (spec/launcher.md). |
|
external
Package external runs a launcher that lives outside aboard: an aboard-launcher-<name> command that reads one JSON request on standard input and answers with one JSON response on standard output (spec/launcher.md).
|
Package external runs a launcher that lives outside aboard: an aboard-launcher-<name> command that reads one JSON request on standard input and answers with one JSON response on standard output (spec/launcher.md). |
|
headless
Package headless is the built-in headless launcher: it starts a session's command as a background process with no terminal, in a process group of its own, its output in a log file.
|
Package headless is the built-in headless launcher: it starts a session's command as a background process with no terminal, in a process group of its own, its output in a log file. |
|
launchertest
Package launchertest is the launcher kit: one suite every launcher passes, built in or external, so "does my launcher work?" has an answer that doesn't depend on reading Aboard's code.
|
Package launchertest is the launcher kit: one suite every launcher passes, built in or external, so "does my launcher work?" has an answer that doesn't depend on reading Aboard's code. |
|
tmux
Package tmux is the built-in tmux launcher: each swarm gets a tmux server of its own, on a socket named after the swarm, so it never touches the person's own tmux server, and each agent a window in it, named after the agent.
|
Package tmux is the built-in tmux launcher: each swarm gets a tmux server of its own, on a socket named after the swarm, so it never touches the person's own tmux server, and each agent a window in it, named after the agent. |
|
Package mention finds the mentions in a message body: `@name` and `@role:R` written in text, outside code and links.
|
Package mention finds the mentions in a message body: `@name` and `@role:R` written in text, outside code and links. |
|
Package notify wakes readers waiting for changes on a board, or on another key the board package names (such as a human's list of boards), within one server process.
|
Package notify wakes readers waiting for changes on a board, or on another key the board package names (such as a human's list of boards), within one server process. |
|
Package rules holds the rules a board enforces on every write: role permissions, policy presets, who a message is addressed to, and who may read it.
|
Package rules holds the rules a board enforces on every write: role permissions, policy presets, who a message is addressed to, and who may read it. |
|
Package server runs an Aboard server: it opens the database, prepares the server's identity and, in local mode, its owner, then serves the API until the context ends.
|
Package server runs an Aboard server: it opens the database, prepares the server's identity and, in local mode, its owner, then serves the API until the context ends. |
|
store
|
|
|
sqlite
Package sqlite keeps Aboard's data in SQLite: each board's append-only event log, the read models built from it (boards, members, join codes, messages), humans, browser logins, saved responses for idempotent writes and the server's own settings.
|
Package sqlite keeps Aboard's data in SQLite: each board's append-only event log, the read models built from it (boards, members, join codes, messages), humans, browser logins, saved responses for idempotent writes and the server's own settings. |
Click to show internal directories.
Click to hide internal directories.