Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

A tiny Linux command whisperer (Alpha version)

WHIS is a tiny Linux command whisperer/generator based on LLM, written in Python.

The main goals are:

  • minimal interruption of the workflow
  • fast
  • free and unlimited suggestions (with local LLM)
  • privacy (with local LLM)
  • minimalistic interface

Alpha version

Please note that this is an Alpha version and is not ready for production use.
So far it's only tested on Ubuntu 24.04 and Python 3.12.

Usage

Showcase

Install

  1. Install pipx
  2. Install WHIS with pipx
    • pipx install whis-cli
  3. Configure your provider and model by either
    • a) Config file: ~/.config/whis/config.toml (or XDG_CONFIG_HOME/whis/config.toml if you use a different location)
      • create/edit the file with:
        llm_provider = "ollama"   # e.g. ollama, openai
        llm_model = "qwen2:7b"    # e.g. qwen2:7b, gpt-4o-mini
        
    • b) Environment variables (have priority over config file)
      • WHIS_LLM_PROVIDER
      • WHIS_LLM_MODEL
  4. Run whis interactive session by running whis in terminal

Todo (business logic)

  • one-shot mode: whis "list mp3 files" without the interactive session
  • explain command that sends request for a brief explanation of the command
    • should use a new conversation without a previous context
  • continue - loads old session and continues refining
  • API support
    • Gemini
    • Anthropic
    • OpenAI-compatible API (LM Studio, LocalAI...)
  • dangerous commands red warning (e.g. rm stuff)
  • whis inner history - arrow up should get the latest input even after session restart
  • interactive configuration

    • whis config
      • provider, model
      • action - copy+paste, copy, maybe execute?
  • other modes (current "quit then paste" feels unreliable)
    • copy to clipboard
    • execute directly (dangerous)
  • more dynamic context in system prompt (OS, pwd, git branch, etc.) - some might need user permission
  • command syntax check before suggestion
  • use one specific color for all responses and another for user inputs

Todo (technical)

  • Python versions support (3.10+)
  • tests
  • consider click for CLI
  • checks
    • flake8
    • black
    • isort
    • mypy
  • better command pasting (now it uses xdotool and xclip with process forking) using bash functions
  • there seems to be a conflict between black and ruff

Release files for whis-cli 0.1.0a3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for whis-cli 0.1.0a3
File Size Uploaded
whis_cli-0.1.0a3.tar.gz 12.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for whis-cli 0.1.0a3
File Interpreter ABI Platform
whis_cli-0.1.0a3-py3-none-any.whl Python 3 none any Details

Total release size: 25.8 kB

Release files / whis_cli-0.1.0a3.tar.gz

Download URL whis_cli-0.1.0a3.tar.gz
Size 12.8 kB
Tags Source
SHA-256 checksum
How to use checksums
1731e02904ec72a921e4295c7c8023ed232cd51d154e9291f4c5661d813472ed
BLAKE2b-256 checksum
How to use checksums
d5e39d2ff50c6956958b56b75b556497fa1d616c6ed5629eb13862a2a1ee963d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.9

Release files / whis_cli-0.1.0a3-py3-none-any.whl

Download URL whis_cli-0.1.0a3-py3-none-any.whl
Size 13.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
461bf3c2d94580a360285606946d4ad01a6f5284417daa0a96ccad4bd4a16a27
BLAKE2b-256 checksum
How to use checksums
1af1f199669d7687e1a126dfdc952f73d82e22871d85f016a350ed520664df4d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.9

Release history Release notifications | RSS feed

This release

0.1.0a3 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page