* docs: generate CLI reference from live help * docs(cli): move bd version stamp from per-command pages to index only Drops the `(bd version X.Y.Z)` suffix from the auto-generated header on every per-command CLI reference page (writeSingleCommandDoc) and the docs/CLI_REFERENCE.md preamble (writeAllHelp). The version label now lives only on the index page emitted by scripts/generate-cli-docs.sh: - Dev tree (website/docs/cli-reference/index.md, docs/CLI_REFERENCE.md): labelled "Latest" - Versioned snapshots (website/versioned_docs/version-X.Y.Z/...): labelled with the explicit semver tag parsed from the directory name This eliminates the 100+-file no-signal diff a release version bump otherwise produces, restoring the "regen as a separate small commit" workflow PR #3704 enables. After this change a version bump alone yields zero diff on the dev tree; only the new versioned snapshot created at release-cut time carries the new tag. No datestamps are introduced anywhere — scripts/generate-cli-docs.sh --check remains deterministic across CI runs. Refs: mybd-afb, PR #3704 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: CI Bot <ci@beads.test> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
60 lines
1.4 KiB
Markdown
60 lines
1.4 KiB
Markdown
---
|
|
id: audit
|
|
title: bd audit
|
|
slug: /cli-reference/audit
|
|
sidebar_position: 999
|
|
---
|
|
|
|
<!-- AUTO-GENERATED: do not edit manually -->
|
|
Generated from `bd help --doc audit`
|
|
|
|
## bd 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
|
|
```
|
|
|
|
### 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)
|
|
```
|