{"_id":"@brngdsn/vox","_rev":"2-5e28f585575fd5c267b4628a1df96248","name":"@brngdsn/vox","dist-tags":{"latest":"0.2.4"},"versions":{"0.2.2":{"name":"@brngdsn/vox","version":"0.2.2","keywords":["ecmascript","javascript","nodejs","llm","ai","agent","multi-modal","openai"],"author":{"name":"brn.gdsn@gmail.com"},"license":"ISC","_id":"@brngdsn/vox@0.2.2","maintainers":[{"name":"brngdsn","email":"brn.gdsn@gmail.com"}],"homepage":"https://github.com/brngdsn/vox#readme","bugs":{"url":"https://github.com/brngdsn/vox/issues"},"bin":{"vox":"src/index.js"},"dist":{"shasum":"b362f5a30fee8b91473556b765c1d1322d63fc09","tarball":"https://registry.npmjs.org/@brngdsn/vox/-/vox-0.2.2.tgz","fileCount":5,"integrity":"sha512-B8RMaijpCSvsnkO+uiBgFagvM6QVH/3x4jA1ban3rhsT7zG+8kkrdF+2KtTwKxR3jn3yS4YZ1gQmShZzQo0W5w==","signatures":[{"sig":"MEUCIFwdtmVnRyYpuD1TLkNaTegP74Ubjsf4Isd/qEPXOrgsAiEAmZaM6MvxBn1X2WKWLe6KMqHo+Qsn3m10CV7OJ+aLaWw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":28856},"main":"src/index.js","type":"module","gitHead":"abf30261d4119ce8099adc37e5be4adc2dd3a7fc","scripts":{"test":"jest"},"_npmUser":{"name":"brngdsn","email":"brn.gdsn@gmail.com"},"repository":{"url":"git+https://github.com/brngdsn/vox.git","type":"git"},"_npmVersion":"10.8.3","description":"voice-operated execution","directories":{},"_nodeVersion":"20.8.0","dependencies":{"ora":"^8.1.0","open":"^10.1.0","uuid":"^10.0.0","dotenv":"^16.4.5","openai":"^4.63.0","express":"^4.21.0","numeral":"^2.0.6","node-mic":"^1.0.1","readline":"^1.3.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/vox_0.2.2_1727104886341_0.11871295204850973","host":"s3://npm-registry-packages"}},"0.2.3":{"name":"@brngdsn/vox","version":"0.2.3","keywords":["ecmascript","javascript","nodejs","llm","ai","agent","multi-modal","openai"],"author":{"name":"brn.gdsn@gmail.com"},"license":"ISC","_id":"@brngdsn/vox@0.2.3","maintainers":[{"name":"brngdsn","email":"brn.gdsn@gmail.com"}],"homepage":"https://github.com/brngdsn/vox#readme","bugs":{"url":"https://github.com/brngdsn/vox/issues"},"bin":{"vox":"src/index.js"},"dist":{"shasum":"81a86f2c3f1cd891aa5561dff7e29e774cc9f313","tarball":"https://registry.npmjs.org/@brngdsn/vox/-/vox-0.2.3.tgz","fileCount":6,"integrity":"sha512-B4/vgG56WoiFynXWc2wuMnaVB8XBDUHY6KOTvT5P9x3mbUxzWy8nxpCOLGFG/B49swTNNO03PoMacJrisqo+OQ==","signatures":[{"sig":"MEYCIQDhTb1gF1o4MXz2shOWjJB2w1MzbqsjbYOT4w6Ii6i3wgIhAI3/w23kSlhzn4PmrDpwjEq8kPrSKlOvD1p7eBqc7+RQ","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":38520},"main":"src/index.js","type":"module","gitHead":"1c731cd9f8fedf3ce4b8fecda1706945bff1f37c","scripts":{"test":"jest"},"_npmUser":{"name":"brngdsn","email":"brn.gdsn@gmail.com"},"repository":{"url":"git+https://github.com/brngdsn/vox.git","type":"git"},"_npmVersion":"10.8.3","description":"voice-operated execution","directories":{},"_nodeVersion":"20.8.0","dependencies":{"ora":"^8.1.0","open":"^10.1.0","uuid":"^10.0.0","dotenv":"^16.4.5","openai":"^4.63.0","express":"^4.21.0","numeral":"^2.0.6","node-mic":"^1.0.1","readline":"^1.3.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/vox_0.2.3_1727105713343_0.21839707183098134","host":"s3://npm-registry-packages"}},"0.2.4":{"name":"@brngdsn/vox","version":"0.2.4","type":"module","description":"voice-operated execution","main":"src/index.js","bin":{"vox":"src/index.js"},"scripts":{"test":"jest"},"repository":{"type":"git","url":"git+https://github.com/brngdsn/vox.git"},"keywords":["ecmascript","javascript","nodejs","llm","ai","agent","multi-modal","openai"],"author":{"name":"brn.gdsn@gmail.com"},"license":"ISC","bugs":{"url":"https://github.com/brngdsn/vox/issues"},"homepage":"https://github.com/brngdsn/vox#readme","dependencies":{"chalk":"^5.2.0","dotenv":"^16.4.5","express":"^4.21.0","node-mic":"^1.0.1","numeral":"^2.0.6","open":"^10.1.0","openai":"^4.63.0","ora":"^8.1.0","readline":"^1.3.0","uuid":"^10.0.0"},"_id":"@brngdsn/vox@0.2.4","gitHead":"fb8c98ca7a465e28e3504e6e35479a8b2f568b69","_nodeVersion":"20.8.0","_npmVersion":"10.1.0","dist":{"integrity":"sha512-wCwJtb4/baalS+6tZeTPeHg5FaJzR5PT//vlWPdYPE6GZfsVEmADkbVAGhgcsTgmYq7ivVX7/0dmPERjyGva0g==","shasum":"651c10fa2dec46ed17395c4329f9f6445ef7b004","tarball":"https://registry.npmjs.org/@brngdsn/vox/-/vox-0.2.4.tgz","fileCount":15,"unpackedSize":47539,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCICWmvCAxQ1QbEqy39aLpLGpBE2WKCVQwoLej0RscV3PzAiEAnTbDE7t8PPX8KSowoQcl+0NcD+DPtPzy3euNBcOv/To="}]},"_npmUser":{"name":"brngdsn","email":"brn.gdsn@gmail.com"},"directories":{},"maintainers":[{"name":"brngdsn","email":"brn.gdsn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/vox_0.2.4_1739633212998_0.5753870415090003"},"_hasShrinkwrap":false}},"time":{"created":"2024-09-23T15:21:26.229Z","modified":"2025-02-15T15:26:53.380Z","0.2.2":"2024-09-23T15:21:26.563Z","0.2.3":"2024-09-23T15:35:13.622Z","0.2.4":"2025-02-15T15:26:53.191Z"},"bugs":{"url":"https://github.com/brngdsn/vox/issues"},"author":{"name":"brn.gdsn@gmail.com"},"license":"ISC","homepage":"https://github.com/brngdsn/vox#readme","keywords":["ecmascript","javascript","nodejs","llm","ai","agent","multi-modal","openai"],"repository":{"type":"git","url":"git+https://github.com/brngdsn/vox.git"},"description":"voice-operated execution","maintainers":[{"name":"brngdsn","email":"brn.gdsn@gmail.com"}],"readme":"# VOX - Voice Operated eXecution\r\n\r\n![VOX Logo](./assets/vox-logo.png)\r\n\r\nVOX is a powerful **Node.js CLI tool** that allows you to execute commands using your voice. Leveraging the capabilities of **OpenAI's Whisper** for transcription and intelligent processing, VOX provides an interactive and efficient way to interact with your system through voice commands.\r\n\r\n## Table of Contents\r\n\r\n- [Features](#features)\r\n- [Prerequisites](#prerequisites)\r\n- [Installation](#installation)\r\n- [Configuration](#configuration)\r\n- [Usage](#usage)\r\n  - [Available Commands](#available-commands)\r\n- [Contributing](#contributing)\r\n- [License](#license)\r\n\r\n## Features\r\n\r\n- **Voice Input:** Record audio commands and transcribe them using OpenAI's Whisper model.\r\n- **Interactive CLI:** User-friendly interface with colored outputs and real-time feedback.\r\n- **Directory Indexing:** Summarizes the current directory structure, including file counts and sizes.\r\n- **Environment Checks:** Verifies the presence of essential environment variables and Git repository status.\r\n- **Real-time Feedback:** Visual indicators like spinners and decibel meters enhance user experience.\r\n- **Automated Workspace Handling:** Processes commands and opens relevant workspaces in your browser.\r\n\r\n## Prerequisites\r\n\r\n- **Node.js:** Ensure you have Node.js (v14 or later) installed on your machine. You can download it from [Node.js Official Website](https://nodejs.org/).\r\n- **Git:** (Optional) For version control and repository management. Download from [Git Official Website](https://git-scm.com/).\r\n\r\n## Installation\r\n\r\n1. **Clone the Repository**\r\n\r\n   ```bash\r\n   git clone https://github.com/your-username/vox.git\r\n   cd vox\r\n   ```\r\n\r\n2. **Install Dependencies**\r\n\r\n   Navigate to the project directory and install the necessary dependencies using `npm`:\r\n\r\n   ```bash\r\n   npm install\r\n   ```\r\n\r\nOR\r\n\r\n1. **NPM Install Globally**\r\n\r\n   ```bash\r\n   npm install -g vox\r\n   ```\r\n\r\n## Configuration\r\n\r\n1. **Environment Variables**\r\n\r\n   VOX requires an OpenAI API key to function correctly. Create a `.env` file in the root directory of the project and add your OpenAI API key:\r\n\r\n   ```env\r\n   OPENAI_API_KEY=your_openai_api_key_here\r\n   ```\r\n\r\n   Replace `your_openai_api_key_here` with your actual OpenAI API key. If you don't have one, you can obtain it from the [OpenAI Dashboard](https://platform.openai.com/account/api-keys).\r\n\r\n## Usage\r\n\r\nStart the VOX CLI by running the following command:\r\n\r\n```bash\r\nnode index.js\r\n```\r\n\r\nUpon starting, VOX will display an ASCII art logo, a summary of the current directory, Git repository status, and environment variable checks.\r\n\r\n### Available Commands\r\n\r\nOnce the CLI is running, you can interact with it using the following commands:\r\n\r\n- **/voice**\r\n\r\n  Record audio input and save it to `voice_input.wav`. The audio will be transcribed using OpenAI's Whisper model, and the transcribed text will be processed for command execution.\r\n\r\n  ```bash\r\n  /voice\r\n  ```\r\n\r\n- **/help**\r\n\r\n  Display the help message with a list of available commands.\r\n\r\n  ```bash\r\n  /help\r\n  ```\r\n\r\n- **/exit**\r\n\r\n  Exit the VOX application.\r\n\r\n  ```bash\r\n  /exit\r\n  ```\r\n\r\n## Contributing\r\n\r\nContributions are welcome! If you'd like to contribute to VOX, please follow these steps:\r\n\r\n1. **Fork the Repository**\r\n\r\n   Click the \"Fork\" button at the top right of this page to create a copy of the repository under your GitHub account.\r\n\r\n2. **Create a New Branch**\r\n\r\n   ```bash\r\n   git checkout -b feature/YourFeatureName\r\n   ```\r\n\r\n3. **Make Your Changes**\r\n\r\n   Implement your feature or bug fix.\r\n\r\n4. **Commit Your Changes**\r\n\r\n   ```bash\r\n   git commit -m \"Add your message here\"\r\n   ```\r\n\r\n5. **Push to Your Fork**\r\n\r\n   ```bash\r\n   git push origin feature/YourFeatureName\r\n   ```\r\n\r\n6. **Create a Pull Request**\r\n\r\n   Navigate to the original repository and click \"Compare & pull request\" to submit your changes for review.\r\n\r\n## License\r\n\r\nThis project is licensed under the [MIT License](LICENSE).\r\n\r\n---\r\n\r\n*Developed with ❤️ by the VOX Team*\r\n\r\n# License\r\n\r\nMIT License. See the [LICENSE](LICENSE) file for details.\r\n\r\n# Acknowledgements\r\n\r\n- [OpenAI](https://openai.com/) for providing the Whisper transcription model.\r\n- [Node.js](https://nodejs.org/) for the robust JavaScript runtime.\r\n- [Ora](https://github.com/sindresorhus/ora) for the elegant terminal spinner.\r\n- [Numeral.js](http://numeraljs.com/) for number formatting.\r\n\r\n# Support\r\n\r\nIf you encounter any issues or have questions, feel free to [open an issue](https://github.com/brngdsn/vox/issues) on the repository.\r\n\r\n# Contact\r\n\r\nFor any inquiries or feedback, please reach out to [brn.gdsn@gmail.com](mailto:brn.gdsn@gmail.com).\r\n\r\n---\r\n\r\n© 2024 VOX. All rights reserved.","readmeFilename":"README.md"}