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.8.tar.gz (8.5 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.8-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: querysh-0.1.8.tar.gz
  • Upload date:
  • Size: 8.5 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.8.tar.gz
Algorithm Hash digest
SHA256 32734aea8b9295ba562a82965073f0e11bc09021f4e206cdd049bf18bd986abb
MD5 3b9af9720d0dc8d9386db004a7488a1a
BLAKE2b-256 b8e89c27609497f084a7b7ff1f8da8e42d53e6cfcb4a6a2012621350ca7bc964

See more details on using hashes here.

File details

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

File metadata

  • Download URL: querysh-0.1.8-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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 e01f759107908f9e21308ab4d487fa291f844be8ba5022bb448ccc1a36edf34d
MD5 8f10c66503562280a9fa644cd669f789
BLAKE2b-256 c52d52a66e2275ed2cfacc3543e777537109cca9ac33ce533b6a5900235d485a

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