Directories
¶
| Path | Synopsis |
|---|---|
|
Package auditcli is the bide audit command: it produces and verifies audit ProofBundles from the command line, for the auditor/compliance persona who does not write Go.
|
Package auditcli is the bide audit command: it produces and verifies audit ProofBundles from the command line, for the auditor/compliance persona who does not write Go. |
|
auditmain
command
Command auditmain is the audit CLI as a program of its own, which the auditcli tests build to run a binary (exit statuses, the version stamp, files resolved from the working directory).
|
Command auditmain is the audit CLI as a program of its own, which the auditcli tests build to run a binary (exit statuses, the version stamp, files resolved from the working directory). |
|
Package errgroup runs a group of functions in goroutines, collects the first error, and cancels the group's context when one fails.
|
Package errgroup runs a group of functions in goroutines, collects the first error, and cancels the group's context when one fails. |
|
Package journalhook gives the packages of this module that write raw journal records (audit's leaves, plan's flow records) the journal's step functions without them being part of package agent's API.
|
Package journalhook gives the packages of this module that write raw journal records (audit's leaves, plan's flow records) the journal's step functions without them being part of package agent's API. |
|
Package journaltest gives bide's own tests what a journal keeps unexported: a raw record write.
|
Package journaltest gives bide's own tests what a journal keeps unexported: a raw record write. |
|
Package jsonfields finds the fields encoding/json reads from a JSON object into a Go struct.
|
Package jsonfields finds the fields encoding/json reads from a JSON object into a Go struct. |
|
Package mermaid writes text into a Mermaid diagram as data.
|
Package mermaid writes text into a Mermaid diagram as data. |
|
Package runview is a read-only, local web viewer for a journal's runs: a run list (RunList) with each run's kind and state, and one run's page: a plan flow's declared topology with the run's path drawn over it, or an agent run's timeline of model turns, tool calls, attempts, approvals and halts, with the audit verdict when a signed head or evidence package is given.
|
Package runview is a read-only, local web viewer for a journal's runs: a run list (RunList) with each run's kind and state, and one run's page: a plan flow's declared topology with the run's path drawn over it, or an agent run's timeline of model turns, tool calls, attempts, approvals and halts, with the audit verdict when a signed head or evidence package is given. |
|
runlistdemo
Package runlistdemo writes a journal of runs in every state the bide view run list tells apart: completed, halted (outcome unknown), waiting for approval, in progress, aborted and cancelled, agent runs and plan flow runs, and one run journaled as a version that recorded no start time.
|
Package runlistdemo writes a journal of runs in every state the bide view run list tells apart: completed, halted (outcome unknown), waiting for approval, in progress, aborted and cancelled, agent runs and plan flow runs, and one run journaled as a version that recorded no start time. |
|
Package strictjson decodes JSON so that what a reader sees in the text is exactly what the decoded value holds.
|
Package strictjson decodes JSON so that what a reader sees in the text is exactly what the decoded value holds. |
|
Package toolhook holds the hooks by which a tool wrapper in this module (audit's AttenuatingSubAgent) takes part in the agent's engine without exported API: the agent checks for these interfaces, and only packages of this module can name them.
|
Package toolhook holds the hooks by which a tool wrapper in this module (audit's AttenuatingSubAgent) takes part in the agent's engine without exported API: the agent checks for these interfaces, and only packages of this module can name them. |
|
tools
|
|
|
doccheck
command
Command doccheck enforces bide's documentation policy over every module in the repository: every exported type, func, method, package-level const and var has a doc comment that starts with its name, and every package has a package comment ("Package name ..." outside package main).
|
Command doccheck enforces bide's documentation policy over every module in the repository: every exported type, func, method, package-level const and var has a doc comment that starts with its name, and every package has a package comment ("Package name ..." outside package main). |
|
docsnip
command
Command docsnip checks that every Go code block in bide's documentation compiles against the current code, so the docs cannot drift silently when an API changes.
|
Command docsnip checks that every Go code block in bide's documentation compiles against the current code, so the docs cannot drift silently when an API changes. |
|
docsnip/snip
Package snip reads the Go code blocks of bide's markdown documentation and makes each a Go file, which docsnip type-checks.
|
Package snip reads the Go code blocks of bide's markdown documentation and makes each a Go file, which docsnip type-checks. |
|
modelsync
command
Command modelsync keeps bide's Go code and its TLA+ models (spec/tla) in step.
|
Command modelsync keeps bide's Go code and its TLA+ models (spec/tla) in step. |
|
oldnames
command
Command oldnames fails when a name the pre-1.0 API redesign removed (docs/design/api-v1.md, section 10.2) appears in bide's Go code, its godoc, or its documentation: the transitional names (RunMessage, Build, ResolveHaltRef, ...), the string entry points they replaced (RunSaga, RunResult, ...), the pause aliases, the Durable interface and its shims, the old Tool method set's SpecOf, the context decorators, the mcp package's old path, and agent.ScriptedModel.
|
Command oldnames fails when a name the pre-1.0 API redesign removed (docs/design/api-v1.md, section 10.2) appears in bide's Go code, its godoc, or its documentation: the transitional names (RunMessage, Build, ResolveHaltRef, ...), the string entry points they replaced (RunSaga, RunResult, ...), the pause aliases, the Durable interface and its shims, the old Tool method set's SpecOf, the context decorators, the mcp package's old path, and agent.ScriptedModel. |
Click to show internal directories.
Click to hide internal directories.