47 lines
1.6 KiB
Markdown
47 lines
1.6 KiB
Markdown
# Audita
|
|
|
|
Audita is a CLI that polishes transcript JSON using glossary-aware and LLM-backed correction modules.
|
|
|
|
## Quickstart
|
|
|
|
Build:
|
|
|
|
```sh
|
|
go build -o ./bin/audita ./cmd/audita
|
|
```
|
|
|
|
Run the shortest useful command:
|
|
|
|
```sh
|
|
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:
|
|
|
|
```sh
|
|
audita config validate --config ./audita.yml
|
|
audita config print-effective --config ./audita.yml
|
|
```
|
|
|
|
## Documentation
|
|
|
|
- CLI reference: [`docs/cli.md`](docs/cli.md)
|
|
- Configuration reference: [`docs/config.md`](docs/config.md)
|
|
- Operations guide: [`docs/operations.md`](docs/operations.md)
|
|
- Troubleshooting: [`docs/troubleshooting.md`](docs/troubleshooting.md)
|
|
- Subprocess integration: [`docs/integrations/subprocess.md`](docs/integrations/subprocess.md)
|
|
- OpenAI-compatible LLM integration: [`docs/integrations/openai-compatible-llm.md`](docs/integrations/openai-compatible-llm.md)
|
|
- Transcript and glossary file integration: [`docs/integrations/transcript-glossary-files.md`](docs/integrations/transcript-glossary-files.md)
|
|
- Development workflow: [`docs/policy/development.md`](docs/policy/development.md)
|
|
- Architecture policy: [`docs/policy/architecture.md`](docs/policy/architecture.md)
|
|
- Documentation policy: [`docs/policy/documentation.md`](docs/policy/documentation.md)
|