⚠️ Internal Alpha - This project is in early development and not ready for production use.
⚠️ CRITICAL: Documentation and feature status changes quickly. Seedocs/plans/critical-action-plan.mdfor what currently works.
Minimal root README. Full developer & architecture guide: see CLAUDE.md. Assistants should read AGENTS.md.
Status varies by STT backend and platform. For current “what works” details, see docs/plans/critical-action-plan.md.
# Main app
cargo run -p coldvox-app --bin coldvox
# TUI dashboard
cargo run -p coldvox-app --bin tui_dashboardCommon Rust commands:
# Fast local feedback
cargo check -p coldvox-app
# Format check
cargo fmt --all -- --checkThis project uses a git hook standard powered by mise and lint-staged.
- Install mise:
curl https://mise.run | sh(or see docs) - Install toolchain:
mise install - Activate hooks + agent mirrors:
mise run prepare
To run the hook pipeline manually:
mise run pre-commit- Review the Master Documentation Playbook.
- Follow the repository Documentation Standards.
- Coordinate work through the Documentation Todo Backlog.