Skip to main content

A lightweight OpenAI-powered Bash actuator.

Project description

BHMsh

A lightweight OpenAI-powered Bash actuator.

Installation

python3 -m pip install --upgrade bhmsh

BHMsh requires Python 3.8 or greater and a Unix-based OS (macOS or Linux).

With that being said, there are currently build issues with the latest Python 3.12: use 3.8 - 3.11.

Python 3 Setup (Supplementary)

Download an acceptable version of Python 3 here.

To verify:

python3 --version

If you don't see the correct version after running this, you may need to consult the interent on Python installation locations for your specific OS. And then you'll need to update your PATH environment variable accordingly.

Once you have an acceptable version of Python 3, doing the following doesn't hurt:

python3 -m pip install --upgrade pip setuptools wheel

Usage

Most basic execution explicitly using your OpenAI API key:

bhmsh -t <your-openai-api-key>

You can also execute BHMsh in the following manner:

bhmsh

This will check your current environment for an exported variable OPENAI_API_KEY containing your OpenAI API key.

If you want to see a log of BHMsh's interation with GPTsh:

bhmsh --log

This will create a tail-able log file (tail -f <path-to-log> in a concurrent terminal). Its path is given upon execution.

For full execution parameter details:

bhmsh --help

Major runtime commands

Command Description
(c)lear Starts a new ChatGPT session
(q)uit, (e)xit Quit BHMsh

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

bhmsh-0.0.8.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

bhmsh-0.0.8-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file bhmsh-0.0.8.tar.gz.

File metadata

  • Download URL: bhmsh-0.0.8.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for bhmsh-0.0.8.tar.gz
Algorithm Hash digest
SHA256 c3a16fb77eee930f03f92d4254c3d1bd38425ff9bd2f83e301b976a04395b4a2
MD5 28a2eaaf85af117c450f1ecaebfff225
BLAKE2b-256 371acd69152f1d04657109dfe462eeba4f141633092b5a7d057b6d9eefdfa6e1

See more details on using hashes here.

File details

Details for the file bhmsh-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: bhmsh-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for bhmsh-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 0b4084acbf882a6d8a8d1d52d6533a1cfcff060a228a2863becff7179971ff92
MD5 c60cd819895be31e1fc57fe04cb9b894
BLAKE2b-256 1bdcf481a1264e2607519978304acad6c67d714ef47bfd9092e7d3a1624ff9fa

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page