34 lines
1.4 KiB
Markdown
34 lines
1.4 KiB
Markdown
# Repository Guidelines
|
|
|
|
## Project Structure & Module Organization
|
|
|
|
- `src/leld.py` is the primary entrypoint (X11 transcription daemon).
|
|
- `src/recorder.py` handles audio capture using PortAudio via `sounddevice`.
|
|
- `src/stt.py` wraps faster-whisper for transcription.
|
|
|
|
## Build, Test, and Development Commands
|
|
|
|
- Install deps: `uv sync`.
|
|
- Run daemon: `uv run python3 src/leld.py --config ~/.config/lel/config.json`.
|
|
- Open settings: `uv run python3 src/leld.py --settings --config ~/.config/lel/config.json`.
|
|
|
|
## Coding Style & Naming Conventions
|
|
|
|
- Shell scripts use Bash with `set -euo pipefail`.
|
|
- Indentation is two spaces; prefer lowercase variable names for locals and uppercase for environment-configured values.
|
|
- Keep functions small and focused; add comments only where the intent is not obvious.
|
|
|
|
## Testing Guidelines
|
|
|
|
- No automated tests are present.
|
|
- If you add tests, include a brief note in `AGENTS.md` with the runner command and test location.
|
|
|
|
## Commit & Pull Request Guidelines
|
|
|
|
- Commit history is minimal and does not establish a convention; use short, imperative messages (e.g., "Add device override").
|
|
- PRs should include a concise description, repro steps, and any environment variables or dependencies added.
|
|
|
|
## Configuration Tips
|
|
|
|
- Audio input is controlled via `WHISPER_FFMPEG_IN` (device index or name).
|
|
- Model, language, device, and extra args can be set with `WHISPER_MODEL`, `WHISPER_LANG`, `WHISPER_DEVICE`, and `WHISPER_EXTRA_ARGS`.
|