Directories
¶
| Path | Synopsis |
|---|---|
|
Package config is factory-agent's local, owner-controlled configuration (design/workstreams/agent/LLD/supervise.md §The local config): the dispatcher, the pool, the enrollment token file, labels, the harnesses' dedicated config dirs, and the owner's lending consent.
|
Package config is factory-agent's local, owner-controlled configuration (design/workstreams/agent/LLD/supervise.md §The local config): the dispatcher, the pool, the enrollment token file, labels, the harnesses' dedicated config dirs, and the owner's lending consent. |
|
Package effector is the Effector (design/workstreams/agent/LLD/effector.md): every change a run makes on GitHub goes through it.
|
Package effector is the Effector (design/workstreams/agent/LLD/effector.md): every change a run makes on GitHub goes through it. |
|
Package enroll keeps an enrolled agent's registration credential (P1 §6): the refresh token in the supervisor's state dir, 0600, and before the first registration the one-time enrollment token from the file the config names.
|
Package enroll keeps an enrolled agent's registration credential (P1 §6): the refresh token in the supervisor's state dir, 0600, and before the first registration the one-time enrollment token from the file the config names. |
|
Package envrun brings a task's VM workspace environment up and down (P1 §4, workspace-run.md §internal/agent/envrun): it runs spec.environment's setup and up scripts, waits for its ready checks, and runs its down script at the end.
|
Package envrun brings a task's VM workspace environment up and down (P1 §4, workspace-run.md §internal/agent/envrun): it runs spec.environment's setup and up scripts, waits for its ready checks, and runs its down script at the end. |
|
Package gateway is the workspace gateway (gateway.md): an explicit forward proxy that is the workspace's only TCP route out.
|
Package gateway is the workspace gateway (gateway.md): an explicit forward proxy that is the workspace's only TCP route out. |
|
ca
Package ca is the agent host's gateway CA (gateway.md, "The CA"): a name-constrained ECDSA P-256 certificate authority whose leaves the gateway presents for the hosts it intercepts.
|
Package ca is the agent host's gateway CA (gateway.md, "The CA"): a name-constrained ECDSA P-256 certificate authority whose leaves the gateway presents for the hosts it intercepts. |
|
chatgpt
Package chatgpt is the codex ChatGPT login the gateway sends to chatgpt.com, and its Refresher (gateway.md, "ChatGPT refresh").
|
Package chatgpt is the codex ChatGPT login the gateway sends to chatgpt.com, and its Refresher (gateway.md, "ChatGPT refresh"). |
|
policy
Package policy holds the workspace gateway's decisions as data (gateway.md): the host classes and what a CONNECT or a plain HTTP request to each gets, the egress check (the task's mode and allow list, the deny table, the open addresses), the github.com, api.github.com (with the GraphQL read check), dispatcher and model host (methods and path lists) request rules, the refusal codes and bodies, and the cookie filter of the model hosts.
|
Package policy holds the workspace gateway's decisions as data (gateway.md): the host classes and what a CONNECT or a plain HTTP request to each gets, the egress check (the task's mode and allow list, the deny table, the open addresses), the github.com, api.github.com (with the GraphQL read check), dispatcher and model host (methods and path lists) request rules, the refusal codes and bodies, and the cookie filter of the model hosts. |
|
Package gitcred is the run pipeline's in-memory git credential helper (run-pipeline.md §Steps 2): git asks `factory-agent fx git-credential get` for a credential, and the helper asks the worker over a Unix socket that only the worker's user can open.
|
Package gitcred is the run pipeline's in-memory git credential helper (run-pipeline.md §Steps 2): git asks `factory-agent fx git-credential get` for a credential, and the helper asks the worker over a Unix socket that only the worker's user can open. |
|
Package harness is the seam between the run pipeline and the coding-agent CLIs it drives (design/workstreams/agent/LLD/harness-adapters.md): the Adapter interface each harness implements (Codex in AGT-S1-T03, Claude Code in AGT-S1-T04, the scriptable fake in harness/fake), the Workspace the pipeline prepares for it, and the EventSink it reports progress, usage and rate limits to.
|
Package harness is the seam between the run pipeline and the coding-agent CLIs it drives (design/workstreams/agent/LLD/harness-adapters.md): the Adapter interface each harness implements (Codex in AGT-S1-T03, Claude Code in AGT-S1-T04, the scriptable fake in harness/fake), the Workspace the pipeline prepares for it, and the EventSink it reports progress, usage and rate limits to. |
|
claudecode
Package claudecode is the Claude Code CLI harness adapter (design/workstreams/agent/LLD/ harness-adapters.md §Claude Code).
|
Package claudecode is the Claude Code CLI harness adapter (design/workstreams/agent/LLD/ harness-adapters.md §Claude Code). |
|
clirun
Package clirun is what the harness adapters (codex, claudecode) share to drive a coding agent's CLI: running it in its own process group and killing the whole group when the run ends, splitting its stdout into lines for the stream parser, keeping a bounded transcript and stderr tail, and the text helpers their parsers need (rate-limit resets, versions, summaries).
|
Package clirun is what the harness adapters (codex, claudecode) share to drive a coding agent's CLI: running it in its own process group and killing the whole group when the run ends, splitting its stdout into lines for the stream parser, keeping a bounded transcript and stderr tail, and the text helpers their parsers need (rate-limit resets, versions, summaries). |
|
codex
Package codex is the Codex CLI harness adapter (design/workstreams/agent/LLD/ harness-adapters.md §Codex).
|
Package codex is the Codex CLI harness adapter (design/workstreams/agent/LLD/ harness-adapters.md §Codex). |
|
fake
Package fake is a scriptable harness.Adapter for pipeline and worker tests (harness-adapters.md §Fake adapter): scripted progress, usage and results, a scripted repair turn, and ways to simulate a rate limit or a run that only ends when it's stopped.
|
Package fake is a scriptable harness.Adapter for pipeline and worker tests (harness-adapters.md §Fake adapter): scripted progress, usage and results, a scripted repair turn, and ways to simulate a rate limit or a run that only ends when it's stopped. |
|
harnesstest
Package harnesstest has what the harness adapters' tests share: a recording EventSink and an end-to-end rig that runs the real run pipeline against an in-process smart-HTTP git server and dispatcher.
|
Package harnesstest has what the harness adapters' tests share: a recording EventSink and an end-to-end rig that runs the real run pipeline against an in-process smart-HTTP git server and dispatcher. |
|
Package host checks and sets up an agent host for VM workspaces (P1 §7, design/workstreams/agent/LLD/workspace-host.md).
|
Package host checks and sets up an agent host for VM workspaces (P1 §7, design/workstreams/agent/LLD/workspace-host.md). |
|
provision
Package provision holds the agent hosts' workspace bases: base.sh, the provisioning script the tart base VM runs (package host embeds it too), and the kata driver's image, whose build context is kata/ plus base.sh (design/workstreams/agent/LLD/workspace-kata.md, "The image").
|
Package provision holds the agent hosts' workspace bases: base.sh, the provisioning script the tart base VM runs (package host embeds it too), and the kata driver's image, whose build context is kata/ plus base.sh (design/workstreams/agent/LLD/workspace-kata.md, "The image"). |
|
provision/katacontext
command
Command katacontext writes the kata image's build context (provision.WriteKataContext) to a directory and prints its contextSHA256, so a person (make kata-context) and CI build the same context factory-agent does: docker build <dir>.
|
Command katacontext writes the kata image's build context (provision.WriteKataContext) to a directory and prints its contextSHA256, so a person (make kata-context) and CI build the same context factory-agent does: docker build <dir>. |
|
internal
|
|
|
execfile
Package execfile writes files that will be exec'd (the factory shim, a skill's scripts, a harness's copied plugins, the environment's scripts, extracted binaries) so that exec'ing them can't fail with ETXTBSY ("text file busy").
|
Package execfile writes files that will be exec'd (the factory shim, a skill's scripts, a harness's copied plugins, the environment's scripts, extracted binaries) so that exec'ing them can't fail with ETXTBSY ("text file busy"). |
|
exectest
Package exectest writes the scripts factory-agent's tests exec (fake harnesses, wrappers, stubs) through execfile, so that exec'ing them can't fail with ETXTBSY while parallel tests fork.
|
Package exectest writes the scripts factory-agent's tests exec (fake harnesses, wrappers, stubs) through execfile, so that exec'ing them can't fail with ETXTBSY while parallel tests fork. |
|
fakegateway
Package fakegateway is a test-only stand-in for phase 4's gateway (P1 §3): an explicit forward proxy that injects every credential, so the workspace under test never holds one.
|
Package fakegateway is a test-only stand-in for phase 4's gateway (P1 §3): an explicit forward proxy that injects every credential, so the workspace under test never holds one. |
|
Package katahelper is the kata driver's root helper (design/workstreams/agent/LLD/ workspace-kata.md#the-helper-internalagentkatahelper), and the host layout it shares with host init's kata steps.
|
Package katahelper is the kata driver's root helper (design/workstreams/agent/LLD/ workspace-kata.md#the-helper-internalagentkatahelper), and the host layout it shares with host init's kata steps. |
|
Package login is the supervisor's store of the owner's model logins (supervise.md, "The workspace runner"): the Claude token `factory-agent login claude` reads on stdin and the codex ChatGPT login `factory-agent login codex` imports from codex's auth.json.
|
Package login is the supervisor's store of the owner's model logins (supervise.md, "The workspace runner"): the Claude token `factory-agent login claude` reads on stdin and the codex ChatGPT login `factory-agent login codex` imports from codex's auth.json. |
|
Package pipeline is the run pipeline (design/workstreams/agent/LLD/run-pipeline.md): it turns one leased Task into a harness run and the run into a validated Result.
|
Package pipeline is the run pipeline (design/workstreams/agent/LLD/run-pipeline.md): it turns one leased Task into a harness run and the run into a validated Result. |
|
Package probe works out what this machine can offer the dispatcher (supervise.md §factory-agent probe): a HarnessOffer per configured harness, the configured labels, and the base tooling the host itself needs.
|
Package probe works out what this machine can offer the dispatcher (supervise.md §factory-agent probe): a HarnessOffer per configured harness, the configured labels, and the base tooling the host itself needs. |
|
Package runbundle is the run bundle the supervisor writes for a VM workspace, the outcome the VM writes back and the event stream between them (workspace-run.md §The run bundle).
|
Package runbundle is the run bundle the supervisor writes for a VM workspace, the outcome the VM writes back and the event stream between them (workspace-run.md §The run bundle). |
|
Package runner is the seam between the worker's lease loop and what executes a leased task: the worker hands a Runner each Job and reports the Outcome to the dispatcher.
|
Package runner is the seam between the worker's lease loop and what executes a leased task: the worker hands a Runner each Job and reports the Outcome to the dispatcher. |
|
Package sudocancel is how factory-agent cancels a command it runs with a context: a sudo call gets SIGTERM, which sudo relays to its command, and SIGKILL only after a grace; anything else gets SIGKILL at once.
|
Package sudocancel is how factory-agent cancels a command it runs with a context: a sudo call gets SIGTERM, which sudo relays to its command, and SIGKILL only after a grace; anything else gets SIGKILL at once. |
|
sudocanceltest
Package sudocanceltest checks that a runner cancels commands the sudocancel way, with a stand-in for sudo: real sudo never runs.
|
Package sudocanceltest checks that a runner cancels commands the sudocancel way, with a stand-in for sudo: real sudo never runs. |
|
Package vmrun is factory-agent run's runtime inside a VM workspace (workspace-run.md).
|
Package vmrun is factory-agent run's runtime inside a VM workspace (workspace-run.md). |
|
Package worker is factory-agent's worker loop (supervise.md §The worker loop): it registers with the dispatcher (its refresh token, else the one-time enrollment token), long-polls for leases, runs each leased task through a runner.Runner while heartbeating, reports the Outcome (complete, abandon, throttle), and drains on SIGTERM.
|
Package worker is factory-agent's worker loop (supervise.md §The worker loop): it registers with the dispatcher (its refresh token, else the one-time enrollment token), long-polls for leases, runs each leased task through a runner.Runner while heartbeating, reports the Outcome (complete, abandon, throttle), and drains on SIGTERM. |
|
Package workspace is the seam between factory-agent supervise and the VM a task runs in (P1 §1, design/workstreams/agent/LLD/supervise.md): a Driver creates, starts, fills, runs, empties and destroys one workspace VM per task.
|
Package workspace is the seam between factory-agent supervise and the VM a task runs in (P1 §1, design/workstreams/agent/LLD/supervise.md): a Driver creates, starts, fills, runs, empties and destroys one workspace VM per task. |
|
kata
Package kata is the workspace driver for Linux: each workspace is a Kata microVM made and run by the root helper (design/workstreams/agent/LLD/workspace-kata.md#the-driver-internalagentworkspacekata), which this driver runs as sudo -n kata-helper <verb>.
|
Package kata is the workspace driver for Linux: each workspace is a Kata microVM made and run by the root helper (design/workstreams/agent/LLD/workspace-kata.md#the-driver-internalagentworkspacekata), which this driver runs as sudo -n kata-helper <verb>. |
|
tart
Package tart is the workspace driver for macOS: it drives the tart CLI (P1 §1, design/workstreams/agent/LLD/supervise.md).
|
Package tart is the workspace driver for macOS: it drives the tart CLI (P1 §1, design/workstreams/agent/LLD/supervise.md). |
|
vmexec
Package vmexec is what the workspace drivers share (design/workstreams/agent/LLD/ workspace-kata.md#the-driver-internalagentworkspacekata): running commands in a workspace through the driver's exec command, and over it Put's and Get's tar streams, Exec with its pid-file cancel, and the network read.
|
Package vmexec is what the workspace drivers share (design/workstreams/agent/LLD/ workspace-kata.md#the-driver-internalagentworkspacekata): running commands in a workspace through the driver's exec command, and over it Put's and Get's tar streams, Exec with its pid-file cancel, and the network read. |
Click to show internal directories.
Click to hide internal directories.