Three generated-content defects from the adversarial review, all structurally invisible to the drift gate (generated-vs-generated): - Usage lines now mirror Cobra's help template: a runnable command shows its UseLine, a command with subcommands shows '<path> [command]', both when both apply. Previously bare UseLine() stamped 'bd mol [flags]' on 30 parent pages — a line the binary never prints. - The generated CLI index publishes the Global Flags block; the binary prints it on every --help but no page carried it. - docsmint neutralizes prose lines that Mintlify's prebuild would dedent into MDX ESM blocks (a line beginning 'export'/'import' outside a fence gets wrapped in a code span). This is why /cli-reference/mail returned HTTP 200 while rendering only a parse-error placeholder — reproduced, fixed, and covered by a planted-hazard test; fenced content stays verbatim. Also rewords check-cli-docs-drift.sh's early-PASS message, which asserted 'the supplied binary differs' as the cause when uncommitted local edits produce the same result. All 113 pages + docs/CLI_REFERENCE.md regenerated through the pipeline; TDD'd in cmd/bd/help_all_test.go and tools/docsmint/docsmint_test.go. Verified live: /cli-reference/mail renders real content, zero parse errors; generate-cli-docs.sh --check, docsync, freshness, and mint broken-links all pass on this tree.
57 lines
1.4 KiB
Markdown
57 lines
1.4 KiB
Markdown
---
|
|
title: "bd audit"
|
|
description: "Record and label agent interactions (append-only JSONL)"
|
|
---
|
|
|
|
{/* AUTO-GENERATED: do not edit manually */}
|
|
|
|
Generated from `bd help --doc audit`.
|
|
|
|
Audit log entries are appended to .beads/interactions.jsonl.
|
|
|
|
Each line is one event. This file is intended to be versioned in git and used for:
|
|
- auditing ("why did the agent do that?")
|
|
- dataset generation (SFT/RL fine-tuning)
|
|
|
|
Entries are append-only. Labeling creates a new "label" entry that references a parent entry.
|
|
|
|
```
|
|
bd audit [command]
|
|
```
|
|
|
|
## bd audit label
|
|
|
|
Append a label entry referencing an existing interaction
|
|
|
|
```
|
|
bd audit label <entry-id> [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
--label string Label value (e.g. "good" or "bad")
|
|
--reason string Reason for label
|
|
```
|
|
|
|
## bd audit record
|
|
|
|
Append an audit interaction entry
|
|
|
|
```
|
|
bd audit record [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
--error string Error string (llm_call/tool_call)
|
|
--exit-code int Exit code (tool_call) (default -1)
|
|
--issue-id string Related issue id (bd-...)
|
|
--kind string Entry kind (e.g. llm_call, tool_call, label)
|
|
--model string Model name (llm_call)
|
|
--prompt string Prompt text (llm_call)
|
|
--response string Response text (llm_call)
|
|
--stdin Read a JSON object from stdin (must match audit.Entry schema)
|
|
--tool-name string Tool name (tool_call)
|
|
```
|