| Name | voxcmd JSON |
| Version |
1.2.1
JSON |
| download |
| home_page | None |
| Summary | A powerful AI assistant and file manager for your terminal |
| upload_time | 2025-10-06 05:32:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
ai
assistant
cli
gemini
file-manager
terminal
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# VoxCmd
A powerful AI assistant and file manager for your terminal, powered by Google Gemini 1.5 Flash.
## Features
- 🤖 **AI-Powered Assistant**: Chat with AI or get command suggestions
- 📁 **File Management**: Create, view, delete, and find files easily
- 🚀 **Natural Language Commands**: Describe what you want, get the right command
- 🎨 **Rich Terminal Output**: Beautiful formatting with Rich library
- ⚡ **Fast and Lightweight**: Built with Typer for optimal performance
## Installation
```bash
pip install voxcmd
```
## Quick Start
1. **Set your Gemini API key**:
```bash
voxcmd set-api-key YOUR_GEMINI_API_KEY
```
2. **Start using VoxCmd**:
```bash
# Ask the AI anything
voxcmd ask "create a python file that prints hello world"
# View files
voxcmd view myfile.txt
# Create files directly
voxcmd create-file app.py --content "print('Hello World!')"
```
## Available Commands
- `voxcmd ask "your question"` - Ask the AI assistant anything
- `voxcmd set-api-key <key>` - Configure your Gemini API key
- `voxcmd create-file <path> --content "..."` - Create files with content
- `voxcmd view <filepath>` - Display file contents
- `voxcmd delete <path>` - Delete files or directories
- `voxcmd find <name>` - Find files by name
- `voxcmd open-path <path>` - Open files/directories in default application
- `voxcmd hello <name>` - Say hello (example command)
- `voxcmd goodbye` - Say goodbye
## Getting a Gemini API Key
1. Go to [Google AI Studio](https://makersuite.google.com/app/apikey)
2. Create a new API key
3. Use it with `voxcmd set-api-key YOUR_KEY`
## Development & Release Process
This project uses automated publishing to PyPI via GitHub Actions.
### For Maintainers
**Releasing a new version:**
1. Update the version number in `pyproject.toml`
2. Commit your changes: `git commit -am "Release v1.x.x"`
3. Create and push a version tag:
```bash
git tag v1.x.x
git push origin v1.x.x
```
4. The GitHub Action will automatically build and publish to PyPI
**Manual Release:**
Alternatively, create a [GitHub Release](https://github.com/santhoshsharuk/voc-cmd/releases) and the package will be published automatically.
### Setting up PyPI Token (for maintainers)
The automated publishing requires a PyPI API token stored as a GitHub secret:
1. Go to [PyPI Account Settings](https://pypi.org/account/) → API tokens
2. Create a new token scoped to this project
3. In your GitHub repository, go to Settings → Secrets and variables → Actions
4. Create a new secret named `PYPI_API_TOKEN` with your token value
## License
MIT License - see LICENSE file for details.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Raw data
{
"_id": null,
"home_page": null,
"name": "voxcmd",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "ai, assistant, cli, gemini, file-manager, terminal",
"author": null,
"author_email": "Santhosh Sharuk <santhoshsharuk16@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/90/b6/d632e474cf982c6a6aa8c7829023853aa8d25cf6b58c00c51c251f51faa0/voxcmd-1.2.1.tar.gz",
"platform": null,
"description": "# VoxCmd\n\nA powerful AI assistant and file manager for your terminal, powered by Google Gemini 1.5 Flash.\n\n## Features\n\n- \ud83e\udd16 **AI-Powered Assistant**: Chat with AI or get command suggestions\n- \ud83d\udcc1 **File Management**: Create, view, delete, and find files easily\n- \ud83d\ude80 **Natural Language Commands**: Describe what you want, get the right command\n- \ud83c\udfa8 **Rich Terminal Output**: Beautiful formatting with Rich library\n- \u26a1 **Fast and Lightweight**: Built with Typer for optimal performance\n\n## Installation\n\n```bash\npip install voxcmd\n```\n\n## Quick Start\n\n1. **Set your Gemini API key**:\n ```bash\n voxcmd set-api-key YOUR_GEMINI_API_KEY\n ```\n\n2. **Start using VoxCmd**:\n ```bash\n # Ask the AI anything\n voxcmd ask \"create a python file that prints hello world\"\n \n # View files\n voxcmd view myfile.txt\n \n # Create files directly\n voxcmd create-file app.py --content \"print('Hello World!')\"\n ```\n\n## Available Commands\n\n- `voxcmd ask \"your question\"` - Ask the AI assistant anything\n- `voxcmd set-api-key <key>` - Configure your Gemini API key\n- `voxcmd create-file <path> --content \"...\"` - Create files with content\n- `voxcmd view <filepath>` - Display file contents\n- `voxcmd delete <path>` - Delete files or directories\n- `voxcmd find <name>` - Find files by name\n- `voxcmd open-path <path>` - Open files/directories in default application\n- `voxcmd hello <name>` - Say hello (example command)\n- `voxcmd goodbye` - Say goodbye\n\n## Getting a Gemini API Key\n\n1. Go to [Google AI Studio](https://makersuite.google.com/app/apikey)\n2. Create a new API key\n3. Use it with `voxcmd set-api-key YOUR_KEY`\n\n## Development & Release Process\n\nThis project uses automated publishing to PyPI via GitHub Actions.\n\n### For Maintainers\n\n**Releasing a new version:**\n\n1. Update the version number in `pyproject.toml`\n2. Commit your changes: `git commit -am \"Release v1.x.x\"`\n3. Create and push a version tag: \n ```bash\n git tag v1.x.x\n git push origin v1.x.x\n ```\n4. The GitHub Action will automatically build and publish to PyPI\n\n**Manual Release:**\nAlternatively, create a [GitHub Release](https://github.com/santhoshsharuk/voc-cmd/releases) and the package will be published automatically.\n\n### Setting up PyPI Token (for maintainers)\n\nThe automated publishing requires a PyPI API token stored as a GitHub secret:\n\n1. Go to [PyPI Account Settings](https://pypi.org/account/) \u2192 API tokens\n2. Create a new token scoped to this project\n3. In your GitHub repository, go to Settings \u2192 Secrets and variables \u2192 Actions\n4. Create a new secret named `PYPI_API_TOKEN` with your token value\n\n## License\n\nMIT License - see LICENSE file for details.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n",
"bugtrack_url": null,
"license": null,
"summary": "A powerful AI assistant and file manager for your terminal",
"version": "1.2.1",
"project_urls": {
"Documentation": "https://github.com/santhoshsharuk/voc-cmd#readme",
"Homepage": "https://github.com/santhoshsharuk/voc-cmd",
"Issues": "https://github.com/santhoshsharuk/voc-cmd/issues",
"Repository": "https://github.com/santhoshsharuk/voc-cmd"
},
"split_keywords": [
"ai",
" assistant",
" cli",
" gemini",
" file-manager",
" terminal"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "317c2f8b0cd67dd6853d584173c766b32c4d061328be111a20ee538223563531",
"md5": "ac721b5b3bb2404303d16d13b74834fc",
"sha256": "611477c8f355a3ea04f16e6ed634e60709a766b5759858a5e728137cc7527aed"
},
"downloads": -1,
"filename": "voxcmd-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ac721b5b3bb2404303d16d13b74834fc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6510,
"upload_time": "2025-10-06T05:32:06",
"upload_time_iso_8601": "2025-10-06T05:32:06.028822Z",
"url": "https://files.pythonhosted.org/packages/31/7c/2f8b0cd67dd6853d584173c766b32c4d061328be111a20ee538223563531/voxcmd-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "90b6d632e474cf982c6a6aa8c7829023853aa8d25cf6b58c00c51c251f51faa0",
"md5": "3104656f5c8e4a605ad1a90e81b9efb7",
"sha256": "5191fee0abb791c9b33ddb8a6fba434b27973cf94f4e09b64232243c143f7a1e"
},
"downloads": -1,
"filename": "voxcmd-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "3104656f5c8e4a605ad1a90e81b9efb7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6122,
"upload_time": "2025-10-06T05:32:07",
"upload_time_iso_8601": "2025-10-06T05:32:07.067937Z",
"url": "https://files.pythonhosted.org/packages/90/b6/d632e474cf982c6a6aa8c7829023853aa8d25cf6b58c00c51c251f51faa0/voxcmd-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-06 05:32:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "santhoshsharuk",
"github_project": "voc-cmd#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "voxcmd"
}
