Documentation
¶
Overview ¶
Command grelot is the grelot server, which coordinates coding agents through one HTTP API, its healthcheck, and the client every agent runs.
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
canon
Package canon maps local paths to grelot's canonical form and back.
|
Package canon maps local paths to grelot's canonical form and back. |
|
cli
Package cli runs grelot's client verbs: it reads the command line, the client config and the shell it runs in, sends the API calls, and prints what an agent reads, the status line first.
|
Package cli runs grelot's client verbs: it reads the command line, the client config and the shell it runs in, sends the API calls, and prints what an agent reads, the status line first. |
|
client
Package client is the grelot command line's core: its config, the API client every verb and hook sends through, the provider a shell runs under, and the status line printed before every answer.
|
Package client is the grelot command line's core: its config, the API client every verb and hook sends through, the provider a shell runs under, and the status line printed before every answer. |
|
hook
Package hook holds what a grelot hook decides before it asks the server: the fields of the host's hook input, which session the hook acts for, and the per-session marks it keeps between runs.
|
Package hook holds what a grelot hook decides before it asks the server: the fields of the host's hook input, which session the hook acts for, and the per-session marks it keeps between runs. |
|
obs
Package obs is grelot's /metrics page: the counters and histograms the server and store record into, and the gauges read from the store at scrape time.
|
Package obs is grelot's /metrics page: the counters and histograms the server and store record into, and the gauges read from the store at scrape time. |
|
proctree
Package proctree reads the process's ancestors, which name the host CLI a hook runs under for provider detection and the take-over hint's proc, and whose arguments tell a one-shot run.
|
Package proctree reads the process's ancestors, which name the host CLI a hook runs under for provider detection and the take-over hint's proc, and whose arguments tell a one-shot run. |
|
protopath
Package protopath holds the rules for grelot's canonical paths, the paths clients and the server exchange.
|
Package protopath holds the rules for grelot's canonical paths, the paths clients and the server exchange. |
|
provider
Package provider reads provider files.
|
Package provider reads provider files. |
|
server
Package server is grelot's HTTP API: the routes of every client verb and hook, the standing and in-turn waits, and the in-memory state behind them (presence, open turns, push state).
|
Package server is grelot's HTTP API: the routes of every client verb and hook, the standing and in-turn waits, and the in-memory state behind them (presence, open turns, push state). |
|
statefile
Package statefile keeps the client's small state files, each replaced whole so a reader never sees half of one.
|
Package statefile keeps the client's small state files, each replaced whole so a reader never sees half of one. |
|
store
Package store holds grelot's state in one bolttable file: identities and their delegate links, threads, messages and their deliveries, reservations, receipt watches, and the leases that expire them.
|
Package store holds grelot's state in one bolttable file: identities and their delegate links, threads, messages and their deliveries, reservations, receipt watches, and the leases that expire them. |
|
transport
Package transport runs a provider's doors: the server's http push and the watcher's exec, stdout and exit doors.
|
Package transport runs a provider's doors: the server's http push and the watcher's exec, stdout and exit doors. |
|
version
Package version reads grelot's version strings: the one a build reports, the one it sends and answers as Grelot-Version, and their order.
|
Package version reads grelot's version strings: the one a build reports, the one it sends and answers as Grelot-Version, and their order. |
|
where
Package where computes the values a client sends about where it runs: a keyed hash of the machine id, the environment id, and one checkout id and remote hash per working tree.
|
Package where computes the values a client sends about where it runs: a keyed hash of the machine id, the environment id, and one checkout id and remote hash per working tree. |
|
Package providers holds the provider files grelot ships, one YAML file per known host, with each host's install files in a folder of the same name.
|
Package providers holds the provider files grelot ships, one YAML file per known host, with each host's install files in a folder of the same name. |
Click to show internal directories.
Click to hide internal directories.