Skip to main content

A shell interface for MLX models

Project description

querysh

A command-line interface that uses local, offline AI to help you write and execute shell commands. Powered by MLX-optimized Llama 3.2 1B Instruct model running entirely on your machine.

Features

  • Natural language to shell command conversion
  • Command validation and safety checks
  • Interactive command execution
  • Rich terminal interface
  • Support for command suggestions and modifications
  • Fully local and offline operation using MLX-optimized Llama 3.2 1B Instruct model
  • No internet connection or API keys required

Installation

Requirements

  • Python 3.8 or higher
  • macOS (for MLX support)

Dependencies

  • mlx-lm>=0.0.6
  • rich>=13.7.0

Install from PyPI

pip install querysh

Install from source

git clone https://github.com/pabl0cesar/querysh.git
cd querysh
pip install -e .

Usage

Simply run the querysh command in your terminal:

querysh

Then describe what you want to do in natural language. For example:

  • "List all files in the current directory"
  • "Find all Python files modified in the last week"
  • "Create a backup of my documents folder"

The AI will suggest appropriate shell commands, and you can choose to execute them or modify them.

Development

Setup

  1. Clone the repository:
git clone https://github.com/pabl0cesar/querysh.git
cd querysh
  1. Create and activate a virtual environment:
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  1. Install development dependencies:
pip install -e ".[dev]"

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

querysh-0.1.2.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

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

querysh-0.1.2-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file querysh-0.1.2.tar.gz.

File metadata

  • Download URL: querysh-0.1.2.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.4

File hashes

Hashes for querysh-0.1.2.tar.gz
Algorithm Hash digest
SHA256 f5cd39f1fd23fa0262e79fdaf983e9ad9e7aa2ed6e82240db2a7b0f20f0941ea
MD5 3b1bcb857bc23def88a4f49b78db48fe
BLAKE2b-256 062fd2174a885cfb6278a0d989fec938ebff6481c29abd8ff83b3f851a86ebf5

See more details on using hashes here.

File details

Details for the file querysh-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: querysh-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.4

File hashes

Hashes for querysh-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b372115d8cecd7e7c18ca0ba03fbf3cf5feff6c57695b3ce60c0b098211e0187
MD5 33d5001c10d3b73ad5d920775960e9bb
BLAKE2b-256 c85b9287198bd5308d324a2068ecc397daa4a0d162bbe301ae9e60f3de7207b9

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