bd help --docs-root now additionally writes docs/cli-reference/ in Mintlify form (frontmatter title as H1, extensionless root-relative links, JSX auto-generated markers since Mintlify parses .md through MDX) and rewrites the CLI Reference pages array inside docs/docs.json via a textual splice that leaves the rest of the file byte-identical — the ~113 nav entries are never hand-maintained. The Docusaurus outputs (docs/CLI_REFERENCE.md, website/docs/cli-reference/, versioned snapshots) are unchanged. generate-cli-docs.sh --check seeds docs/docs.json and docs/cli-reference/ into its scratch root and diffs both; check-cli-docs-drift.sh adds them to GEN_PATHSPECS and the regeneration fingerprint; docs-autofix-push.sh allowlists the new generated paths; check-doc-flags.sh scans the new docs/ subdirectories and requires command coverage in docs/cli-reference/. Includes the initial docs/docs.json scaffold (nav mirrors the Docusaurus sidebar IA) and the generated docs/cli-reference/ pages. TDD: new emitter behavior covered in cmd/bd/help_all_test.go (Mintlify page format, nav splice correctness + idempotence, bare-root generation without docs.json).
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 [flags]
|
|
```
|
|
|
|
## 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)
|
|
```
|