Complete Phase 1 Go skeleton
This commit is contained in:
53
README.md
Normal file
53
README.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# Audita (Go Rewrite)
|
||||
|
||||
Audita is a transcript polishing CLI. The Go implementation at the repository root is the canonical implementation going forward, with a compatibility-first rewrite strategy.
|
||||
|
||||
## Current Status: Phase 1 Skeleton
|
||||
|
||||
The current Go `audita process` command is a passthrough skeleton:
|
||||
|
||||
- loads transcript and glossary files;
|
||||
- validates transcript as well-formed JSON;
|
||||
- writes transcript JSON back unchanged to `--output` or stdout;
|
||||
- writes an early minimal `--report-json` report when requested;
|
||||
- preserves subprocess-safe stdout/stderr behavior.
|
||||
|
||||
Not implemented yet in Phase 1:
|
||||
|
||||
- transcript/glossary schema validation;
|
||||
- normalization;
|
||||
- chunking/proposals;
|
||||
- validators;
|
||||
- LLM calls;
|
||||
- module execution;
|
||||
- full diagnostics retention/report model.
|
||||
|
||||
## Quick Start (Go)
|
||||
|
||||
Run tests:
|
||||
|
||||
```sh
|
||||
go test ./...
|
||||
```
|
||||
|
||||
Run help:
|
||||
|
||||
```sh
|
||||
go run ./cmd/audita --help
|
||||
go run ./cmd/audita process --help
|
||||
```
|
||||
|
||||
Run minimal passthrough:
|
||||
|
||||
```sh
|
||||
go run ./cmd/audita process transcript.json --glossary glossary.yaml --output corrected.json
|
||||
```
|
||||
|
||||
Without `--output`, corrected transcript JSON is written to stdout.
|
||||
|
||||
## Repository Notes
|
||||
|
||||
- `python/` contains the frozen Python implementation retained as behavioral reference during the port.
|
||||
- Go architecture and rewrite guidance:
|
||||
- `docs/architecture.md`
|
||||
- `docs/rewrite-notes.md`
|
||||
Reference in New Issue
Block a user