audita/README.md

Audita

Audita is a CLI that polishes transcript JSON using glossary-aware and LLM-backed correction modules.

Quickstart

Build:

go build -o ./bin/audita ./cmd/audita

Run the shortest useful command:

audita process ./transcript.json --glossary ./glossary.yaml --output ./corrected.json

Notes:

• the transcript JSON path is required as a positional argument;
• --glossary is required;
• without --output, corrected transcript JSON is written to stdout.

Configuration

Audita loads defaults, optional file config, environment overrides, then CLI overrides.

Use these commands to validate and inspect config:

audita config validate --config ./audita.yml
audita config print-effective --config ./audita.yml

Documentation

• CLI reference: docs/cli.md
• Configuration reference: docs/config.md
• Operations guide: docs/operations.md
• Troubleshooting: docs/troubleshooting.md
• Subprocess integration: docs/integrations/subprocess.md
• OpenAI-compatible LLM integration: docs/integrations/openai-compatible-llm.md
• Transcript and glossary file integration: docs/integrations/transcript-glossary-files.md
• Development workflow: docs/policy/development.md
• Architecture policy: docs/policy/architecture.md
• Documentation policy: docs/policy/documentation.md