Quick Navigation

• Why CodeVoice Fits the Hackathon Criteria
• VS Code Integrated Terminal Workflow
• Architecture
• Quick Start
• Voice Command Reference
• Security Model
• Verification and Testing
• License

Why CodeVoice Fits the Hackathon Criteria

1. Real-time dictation and live transcription: Continuous streaming via AssemblyAI's universal-3-5-pro with live in-place partial transcript display and instantaneous turn actions.
2. Multi-language support (18 languages & Hinglish native): Speak naturally in Hindi, English, or mixed Hinglish ("Ek function banao jo email validate kare") without manual language switching. Includes automatic Devanagari-to-Roman script transliteration.
3. Filler-word removal and clean output: AssemblyAI automatically removes disfluencies ("um, uh, like") and formats clean instructions before passing to intent routing.
4. Custom vocabulary and keyterms: 50+ domain-specific keyterms (useEffect, useState, JWT, PCM16, API, Hinglish verb phrases) steered on session connect.

VS Code Integrated Terminal Workflow

+------------------------------------------------------------------------+
| VS Code Editor Tab: demo/sample.ts                                     |
|                                                                        |
| export function validateEmail(email: string): boolean {                |
|   const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;                     |
|   return emailRegex.test(email);     <-- Updates live as you speak!    |
| }                                                                      |
+------------------------------------------------------------------------+
| Integrated Terminal (CodeVoice CLI)                                    |
|                                                                        |
| CodeVoice -- Multilingual Voice Interface for Developers               |
| Active File: demo/sample.ts                                            |
|                                                                        |
| [Listening continuously... Speak now]                                  |
|                                                                        |
| [Transcript: hi-en] Ek function banao jo email validate kare           |
| [Updated] demo/sample.ts (Create an email validation function...)      |
|                                                                        |
| [Transcript: hi-en] Nayi branch banao feature-email                    |
| $ git checkout -b feature-email                                        |
|   Switched to a new branch 'feature-email'                             |
+------------------------------------------------------------------------+

Architecture

Detailed system context diagrams, component responsibilities, streaming WebSocket protocol flow, and security sandbox details are documented in docs/architecture.md.

Quick Start

Global Installation (Recommended)

Install CodeVoice globally from npm:

npm install -g @sizachowdhury/codevoice

Run CodeVoice in any project directory:

codevoice

On first run, CodeVoice will guide you through entering your AssemblyAI and Gemini API keys and save them securely to ~/.codevoice/config.json.

Managing API Keys

# Set your AssemblyAI API key
codevoice config set assemblyai <your-key>

# Set your Gemini API key
codevoice config set gemini <your-key>

# View currently configured keys and sources (safely masked)
codevoice config show

# Clear saved configuration
codevoice config clear

Keys can also be passed via environment variables (ASSEMBLYAI_API_KEY and GEMINI_API_KEY).

Step-by-step installation instructions, cross-platform SoX setup, configuration guides, and testing walkthroughs are documented in docs/quickstart.md.

Voice Command Reference

| Intent | Voice Command (English / Hinglish) | Result | |---|---|---| | Code Generation | "Ek function banao jo email validate kare" | Appends validateEmail directly to active file | | Code Editing | "useEffect ke andar API call add karo" | Modifies active file on disk | | File Switching | "Switch to demo/sample.ts" or "Open auth file" | Changes active file context | | File Creation | "Create file demo.ts" or "Nayi file banao demo.ts" | Switches to / prepares new file | | File Deletion | "Delete demo.ts" or "demo.ts ko delete kar do" | Intercepted by Safety Gate, prompts (y/N), removes file | | Git Branch | "Nayi branch banao feature-email" | $ git checkout -b feature-email | | Git Branch Delete| "Delete branch feature-temp" or "Branch feature-temp delete karo" | Intercepted by Safety Gate, prompts (y/N), $ git branch -D feature-temp | | Git Status | "Git status dikhao" | $ git status | | Git Add | "Sab files add karo" | $ git add . | | Git Commit | "Commit karo add email validation" | $ git commit -m "add email validation" | | Git Log | "Git log dikhao" | $ git log -n 5 --oneline | | Safety Gate | "Force push master" | Intercepted. Prompts (y/N) before executing |

Security Model

Detailed information regarding our kernel-level argument separation (execFile), 8-command Git allowlist, input sanitization, pre-LLM destructive command gate, and credential management is documented in docs/security.md.

Verification and Testing

Comprehensive test suites, execution commands, test coverage breakdowns, and mocking strategies are documented in docs/testing.md. Live validation matrices, end-to-end test results, and evaluator checklists are documented in docs/verification.md.

License

Distributed under the MIT License. See LICENSE for more information.