Skip to main content

A powerful AI assistant and file manager for your terminal

Project description

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

pip install voxcmd

Quick Start

  1. Set your Gemini API key:

    voxcmd set-api-key YOUR_GEMINI_API_KEY
    
  2. Start using VoxCmd:

    # 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
  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:
    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 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 → 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

voxcmd-1.2.1.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

voxcmd-1.2.1-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file voxcmd-1.2.1.tar.gz.

File metadata

  • Download URL: voxcmd-1.2.1.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for voxcmd-1.2.1.tar.gz
Algorithm Hash digest
SHA256 5191fee0abb791c9b33ddb8a6fba434b27973cf94f4e09b64232243c143f7a1e
MD5 3104656f5c8e4a605ad1a90e81b9efb7
BLAKE2b-256 90b6d632e474cf982c6a6aa8c7829023853aa8d25cf6b58c00c51c251f51faa0

See more details on using hashes here.

File details

Details for the file voxcmd-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: voxcmd-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for voxcmd-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 611477c8f355a3ea04f16e6ed634e60709a766b5759858a5e728137cc7527aed
MD5 ac721b5b3bb2404303d16d13b74834fc
BLAKE2b-256 317c2f8b0cd67dd6853d584173c766b32c4d061328be111a20ee538223563531

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page