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.7.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: bhmsh-0.0.7.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.7.tar.gz
Algorithm Hash digest
SHA256 eb2f6931ce96d8b7b5ffa8e4cbd5fad90c9d1aa5b3673be2e01044b11894357b
MD5 ea2ed4aa63957e3064cf8583a1708526
BLAKE2b-256 1189d80ee4aeea89ffc469457cae03e3910694e1d86c3e2655b2b5123b00e9bc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bhmsh-0.0.7-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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 2b2b085af0cf90545165c0cca6e162117e53975f6535f5be38bb5a2b83aad718
MD5 4924b45e400d2c62a25bf860332821d3
BLAKE2b-256 3f01664845e77d68a31497059c2a887a67033a991d4fc9e7d5f7e79be6e43ff9

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