docs: refresh README for v0.4–v0.6 features#53
Merged
Conversation
Four stale sections caught up to current behavior: 1. Canonical Event Schema (now "Wire format") Replaced the old `event_type`/`event_id`/`adapter_version` example (pre-v1.2 envelope shape, removed when we cleaned up the legacy /v1/prompts/ingest-multipart and /v1/transcripts/sync paths in #47) with a real v1.2 envelope: envelope_version, cli_version, tool, hook_event, captured_at, native_payload, and enrichment (git + source + correlation + host/os/arch). Added a field-by-field table and a note that the CLI is intentionally thin — server-side adapters do all categorization. 2. Event Types table — dropped The old `prompt_submit` / `tool_pre` / `session_start` taxonomy was what the CLI used to emit before #47's cleanup. We now ship raw native event names (`UserPromptSubmit`, `preToolUse`, `agentStop`, etc.) — the canonical mapping is a server-side concern, not a CLI one, and listing it in the CLI README was both wrong and likely to drift. Removed. 3. Project Structure tree Added the cmd/ files that landed since the last refresh (upgrade.go, watch.go, insights.go, skills.go, skills_local.go, correlation.go, debug.go) and the new internal/ packages (outbound/, updater/, correlation/). Annotated the entries that are new so a fresh reader knows what they do. 4. Privacy & Security Added bullets describing the outbound mirror file at ~/.config/promptconduit/outbound.ndjson (mode 0600, redaction, 64KB body cap, 50MB rotation) and the once-per-24h GitHub releases check that drives auto-update, including the opt-out paths (`--disable-auto-update=true`, `PROMPTCONDUIT_AUTO_UPDATE=0`). Net diff: +95 / -82 lines, all in README.md. No code changes. https://claude.ai/code/session_019CWBC2E8pQuShejfsKYrvp
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Pure docs update. Four stale sections of the README brought into sync with what the CLI actually does after PRs #47–#51 (auto-update, watch, full hook coverage for all 5 tools, Codex + Copilot support).
1. "Canonical Event Schema" → "Wire format"
The headline schema example in the README was a pre-v1.2 envelope shape (
event_type,event_id,adapter_version) — exactly what we removed in #47's legacy-path cleanup. Replaced with the actual v1.2 envelope we ship today:{ "envelope_version": "1.2", "cli_version": "v0.5.0", "tool": "claude-code", "hook_event": "UserPromptSubmit", "captured_at": "...", "native_payload": { ... }, "enrichment": { "git": { ... }, "source": "github", "correlation": { "trace_id": "...", "span_id": "..." }, "host": "...", "os": "darwin", "arch": "arm64" } }Added a field-by-field table and a clear "CLI is thin, adapters live server-side" framing.
2. Event Types table → dropped
The old
prompt_submit/tool_pre/session_startenum was what the CLI used to emit before #47's cleanup. We now ship raw native event names (UserPromptSubmit,preToolUse,agentStop, etc.) and the canonical mapping is a server-side concern. Keeping it in the CLI README was actively misleading.3. Project Structure tree refreshed
Added the cmd/ files that landed since the last refresh:
upgrade.go,watch.go,insights.go,skills.go,skills_local.go,correlation.go,debug.go. Added the new internal/ packages:outbound/,updater/,correlation/.4. Privacy & Security expanded
Added two bullets documenting the outbound mirror file (
~/.config/promptconduit/outbound.ndjson, mode 0600, redaction rules, 64KB body cap, 50MB rotation) and the background self-upgrade behavior (once-per-24h unauthenticated GitHub releases check) including the opt-out paths.Diff stats
+95 / -82lines, README.md only. No code changes.Test plan
go build ./... && go vet ./... && go test ./...clean (unchanged — no code touched)##/###headings render in TOC orderhttps://claude.ai/code/session_019CWBC2E8pQuShejfsKYrvp
Generated by Claude Code