Files
audita/README.md

62 lines
2.1 KiB
Markdown

# Audita (Go Rewrite)
Audita is a transcript polishing CLI. The Go implementation at the repository root is canonical going forward, and is being delivered compatibility-first against the frozen Python reference in `python/`.
## Current Status: Phase 3 Deterministic Foundation
The current `audita process` implementation includes deterministic input handling and foundation behavior:
- typed transcript parsing for both accepted top-level forms (`[]` and `{ "segments": [...] }`);
- typed glossary YAML parsing;
- transcript and glossary schema validation with actionable errors;
- deterministic same-speaker normalization;
- sequential normalized segment IDs starting at `1`;
- deterministic token estimation;
- contiguous transcript chunking and section summaries;
- normalized transcript JSON output;
- minimal structured `--report-json` output including normalization and chunking summary fields;
- minimal normalization diagnostics artifacts in per-run work directories;
- chunking diagnostics artifacts in per-run work directories;
- subprocess-safe stdout/stderr behavior.
The repository also now contains deterministic proposal foundation packages (models, preview, application, skip reporting, and framework contracts) with fixture/golden tests.
Still not implemented in the Go CLI runtime path:
- real module execution pipeline;
- real `glossary`, `homophones`, `spoken_word`, or `grammar` module behavior;
- LLM proposal generation;
- validator-chain execution;
- concrete structured LLM client implementation;
- final end-to-end transcript polishing behavior.
## Quick Start (Go)
Run tests:
```sh
go test ./...
```
Run help:
```sh
go run ./cmd/audita --help
go run ./cmd/audita process --help
```
Run current deterministic flow:
```sh
go run ./cmd/audita process transcript.json --glossary glossary.yaml --output corrected.json
```
Without `--output`, transcript JSON is written to stdout.
## Repository Notes
- `python/` contains the frozen Python implementation used as behavioral reference during the Go port.
- Architecture and rewrite guidance:
- `docs/architecture.md`
- `docs/rewrite-notes.md`