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.3.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.3-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for querysh-0.1.3.tar.gz
Algorithm Hash digest
SHA256 c5fd8883d1bb7294238e9f2b0043b5418df044ddc33d54be4685ffc8ad6fba3d
MD5 10c441f525a6c4b8dc792f96dbccd33a
BLAKE2b-256 d09863615c0c718b51ca3891e423c59ae21c1f14c420a113cec447b1baf62f84

See more details on using hashes here.

File details

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

File metadata

  • Download URL: querysh-0.1.3-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.13.3

File hashes

Hashes for querysh-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 72c689abbfc368a6acee3232c5e545e2b010585ed7d503f88d7aa57b2d97794b
MD5 f3a14945fe5308907c528ab8d9e60469
BLAKE2b-256 cfea5287a8c1068042875f5176448ace210be9b9a7ec500f776f83680626c61b

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