Skip to main content

Project: hey

Ask a question, get an answer—right in your terminal.

Example

python main.py what was the command to list files in a directory

Features

  • Conversational AI for shell questions and tasks
  • Runs on your machine with Ollama (Llama, Gemma, etc.)
  • Customizable model and system prompt
  • Web search via DuckDuckGo (headless browser)

Requirements

  • Ollama running locally (https://ollama.com/) with a model that supports tool usage. We recommend:
    • Gemma 3 - ollama pull gemma3
  • Python 3.8+
  • playwright (and browsers, see below)
  • langchain, langchain-ollama, langgraph, click, requests

Install & Setup

Install with pipx:

pipx install hey-helper

Or clone this repository and install dependencies:

pip install -r requirements.txt
python -m playwright install

Usage

Ask a question:

python main.py <your question or task>

Force web search (DuckDuckGo):

python main.py --search <your question>

Set config (model/system prompt):

python main.py --set-config

Configuration

  • The first run will create a config file in your OS user config directory.
  • You can change the model or add a system prompt using --set-config.

License

MIT

Metadata

Release files for hey-helper 0.1.0

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

Source distribution (sdist)

Source distribution for hey-helper 0.1.0
File Size Uploaded
hey_helper-0.1.0.tar.gz 4.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for hey-helper 0.1.0
File Interpreter ABI Platform
hey_helper-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 10.3 kB

Release files / hey_helper-0.1.0.tar.gz

Download URL hey_helper-0.1.0.tar.gz
Size 4.9 kB
Tags Source
SHA-256 checksum
How to use checksums
1fddd4470cdada3e99ac98189d2b76f4d3fa53e82f341268162f9581a271f8af
BLAKE2b-256 checksum
How to use checksums
aa0e491ccb302bb7d26b22c1bb483f6e05b36b8d3475040347d3c6f78b047b89
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 16, 2025.

Transparency log

Release files / hey_helper-0.1.0-py3-none-any.whl

Download URL hey_helper-0.1.0-py3-none-any.whl
Size 5.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ed47bac20fea86a1dc506e40a9cb5e836c1473f20b9f26cc72fc69bad6cf2b9a
BLAKE2b-256 checksum
How to use checksums
5d74c3b9157aa55fb38e484d90e1a9732cdb408f0f80a528a7dbcc7a4fbab3c8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 16, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

0.1.0 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