ColdVox

⚠️ Internal Alpha - This project is in early development and not ready for production use.

⚠️ CRITICAL: Documentation and feature status changes quickly. See docs/plans/windows-multi-agent-recovery.md for what currently works.

Minimal root README. Full developer & architecture guide: see CLAUDE.md. Assistants should read AGENTS.md.

North Star

Current product and documentation direction is anchored in:

• docs/northstar.md
• docs/plans/windows-multi-agent-recovery.md
• docs/architecture.md

Quick Start

Status varies by STT backend and platform. For current “what works” details, see docs/plans/windows-multi-agent-recovery.md.

# Main app
cargo run -p coldvox-app --bin coldvox

# TUI dashboard
cargo run -p coldvox-app --bin tui_dashboard

Common Rust commands:

# Fast local feedback
cargo check -p coldvox-app

# Format check
cargo fmt --all -- --check

Development

Developer Git Hooks

Python environments are managed with uv. Git hooks and local tooling bootstrap are handled with mise and lint-staged.

1. Install mise: curl https://mise.run | sh (or see docs)
2. Install toolchain: mise install
3. Activate hooks + agent mirrors: mise run prepare

If you are working on Moonshine or any Python-backed STT flow, run uv sync before building.

To run the hook pipeline manually:

mise run pre-commit

Contributing

• Review the North Star and current execution plan.
• Follow the repository Documentation Standards.
• Coordinate work through the Documentation Todo Backlog.