Directories
¶
| Path | Synopsis |
|---|---|
|
Package amount reads money out of tool arguments for the amount caps of the untrusted-content and amount-caps note (docs/design/untrusted-content-and-amount-caps.md, sections 6.2 and 6.3): the text of an amount to an int64 count of minor units, the ISO 4217 exponent of a currency, the strict reading of a tool's arguments that precedes it, and the one-line grammar of a cap rule.
|
Package amount reads money out of tool arguments for the amount caps of the untrusted-content and amount-caps note (docs/design/untrusted-content-and-amount-caps.md, sections 6.2 and 6.3): the text of an amount to an int64 count of minor units, the ISO 4217 exponent of a currency, the strict reading of a tool's arguments that precedes it, and the one-line grammar of a cap rule. |
|
Package approveline builds the bide approve command line for one call that waits for a decision: the line bide approve -list prints, and the one a notification can carry, so an approver who reads that a call is waiting can run it as it stands.
|
Package approveline builds the bide approve command line for one call that waits for a decision: the line bide approve -list prints, and the one a notification can carry, so an approver who reads that a call is waiting can run it as it stands. |
|
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 browsertest runs the Node scripts that drive a page in Chrome for the packages' tests.
|
Package browsertest runs the Node scripts that drive a page in Chrome for the packages' tests. |
|
Package capledger is the cap ledger of docs/design/untrusted-content-and-amount-caps.md, section 6.5: dense, insert-once slots in a reserved journal run, one ledger per window, each slot a reserve or a release carrying cum_after, the window's total after it.
|
Package capledger is the cap ledger of docs/design/untrusted-content-and-amount-caps.md, section 6.5: dense, insert-once slots in a reserved journal run, one ledger per window, each slot a reserve or a release carrying cum_after, the window's total after it. |
|
capledgerproc
Package capledgerproc runs the cap ledger across real worker processes (re-executions of a store's test binary) for the tests of bide's stores.
|
Package capledgerproc runs the cap ledger across real worker processes (re-executions of a store's test binary) for the tests of bide's stores. |
|
capledgertest
Package capledgertest gives the tests of bide's stores a cap ledger over a Journal on their store: they run it across real processes (store/sqlite, store/postgres) and under an audited store, which the unexported ledger cannot be reached for from another module.
|
Package capledgertest gives the tests of bide's stores a cap ledger over a Journal on their store: they run it across real processes (store/sqlite, store/postgres) and under an audited store, which the unexported ledger cannot be reached for from another module. |
|
Package dbpath names a SQLite database file the one way every handle on it will agree on.
|
Package dbpath names a SQLite database file the one way every handle on it will agree on. |
|
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 filegate queues the writers in one process that share a database file, first come first served, with lease statements ahead of the rest.
|
Package filegate queues the writers in one process that share a database file, first come first served, with lease statements ahead of the rest. |
|
Package identitygate holds the switch that lets an approval gate use certificate-bound approvers.
|
Package identitygate holds the switch that lets an approval gate use certificate-bound approvers. |
|
Package identitypreflight is the engine of bide identity check: a pre-flight for a certificate-bound approval setup, run before go-live and when an approver's decision is refused.
|
Package identitypreflight is the engine of bide identity check: a pre-flight for a certificate-bound approval setup, run before go-live and when an approver's decision is refused. |
|
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 planaccess is what the module's own tools may ask of the plan package that a host may not.
|
Package planaccess is what the module's own tools may ask of the plan package that a host may not. |
|
Package policyfile reads a certificate policy file (audit.ParseIdentityPolicy) from disk, for the commands that check a certificate-bound decision outside a running gate.
|
Package policyfile reads a certificate policy file (audit.ParseIdentityPolicy) from disk, for the commands that check a certificate-bound decision outside a running gate. |
|
Package printable is the rule for text a reviewer reads as an identifier (a node, block or flow name): every character prints.
|
Package printable is the rule for text a reviewer reads as an identifier (a node, block or flow name): every character prints. |
|
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. |
|
Package safefile opens files named by an operator or a host without letting a named pipe stop the program: the open does not wait for a writer, and the caller then asks the opened file (not the path, which may have changed since it was checked) whether it is a regular file.
|
Package safefile opens files named by an operator or a host without letting a named pipe stop the program: the open does not wait for a writer, and the caller then asks the opened file (not the path, which may have changed since it was checked) whether it is a regular file. |
|
safefiletest
Package safefiletest has the helpers the tests of readers built on safefile share: a named pipe to point a reader at, and a deadline that turns a reader waiting for a writer into a failure.
|
Package safefiletest has the helpers the tests of readers built on safefile share: a named pipe to point a reader at, and a deadline that turns a reader waiting for a writer into a failure. |
|
Package sample writes a journal of runs in every state the bide view run list tells apart, driven by the real runtime on scripted models and fake tools (no API key, no network, no hand-written records), with the evidence, keys and flow configs that go with it.
|
Package sample writes a journal of runs in every state the bide view run list tells apart, driven by the real runtime on scripted models and fake tools (no API key, no network, no hand-written records), with the evidence, keys and flow configs that go with it. |
|
Package stopflood is the shared body of the store tests that guard the cost of junk under a stop's generation names.
|
Package stopflood is the shared body of the store tests that guard the cost of junk under a stop's generation names. |
|
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 term styles the bide command's text output for a terminal: a check mark and green for what passed, a cross and red for what failed, amber for a warning or a gate, bold cyan for a path or address to act on, dim for secondary detail.
|
Package term styles the bide command's text output for a terminal: a check mark and green for what passed, a cross and red for what failed, amber for a warning or a gate, bold cyan for a path or address to act on, dim for secondary detail. |
|
Package testca is a small certificate authority for the tests of the approver identity feature (docs/design/approver-identity.md, "Test plan").
|
Package testca is a small certificate authority for the tests of the approver identity feature (docs/design/approver-identity.md, "Test plan"). |
|
Package testcertreceipt builds, for tests, a certificate-bound decision and the files the receipt commands read: the receipt (with and without its anchoring proof), the journal export, signed heads, the log's public key, and the certificate policy file with its trust anchor.
|
Package testcertreceipt builds, for tests, a certificate-bound decision and the files the receipt commands read: the receipt (with and without its anchoring proof), the journal export, signed heads, the log's public key, and the certificate policy file with its trust anchor. |
|
Package themeaccess is what the module's own commands may do with the theme package that a host may not: write a theme's stylesheet and print text from a theme file safely.
|
Package themeaccess is what the module's own commands may do with the theme package that a host may not: write a theme's stylesheet and print text from a theme file safely. |
|
Package themecmd is `bide theme`: the command that checks theme files.
|
Package themecmd is `bide theme`: the command that checks theme files. |
|
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
|
|
|
apiref
Package apiref generates the SDK API reference, docs/reference/api/, from the Go sources of every published module: for each non-internal package its import path, its synopsis and its stability label, then every exported constant, variable, function and type (with the constructors and methods go/doc groups under it) as the declaration and the first sentence of its doc comment.
|
Package apiref generates the SDK API reference, docs/reference/api/, from the Go sources of every published module: for each non-internal package its import path, its synopsis and its stability label, then every exported constant, variable, function and type (with the constructors and methods go/doc groups under it) as the declaration and the first sentence of its doc comment. |
|
changelog
command
Command changelog manages bide's changelog fragments (changes/unreleased, see CONTRIBUTING.md).
|
Command changelog manages bide's changelog fragments (changes/unreleased, see CONTRIBUTING.md). |
|
covmerge
command
Command covmerge merges Go coverage profiles into one, taking the highest count for each block.
|
Command covmerge merges Go coverage profiles into one, taking the highest count for each block. |
|
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. |
|
sendcheck
command
Command sendcheck fails when a goroutine hands a result to another goroutine (a channel send or a close) and only afterwards runs a deferred call that is more than a signal: a decrement, a slot release, an unlock, a flag reset.
|
Command sendcheck fails when a goroutine hands a result to another goroutine (a channel send or a close) and only afterwards runs a deferred call that is more than a signal: a decrement, a slot release, an unlock, a flag reset. |
Click to show internal directories.
Click to hide internal directories.