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

Uploaded Source

Built Distribution

bhmsh-1.1.1-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bhmsh-1.1.1.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-1.1.1.tar.gz
Algorithm Hash digest
SHA256 7442de1d524c6cfba5de430e35cff2dbda0fb998131312880f4c121c5f4dbd5f
MD5 6a70988f627a8ae0df59fb4d7567b3ce
BLAKE2b-256 af1b3a50d7b57e3246d7e6b0c00724f98356691e3cc207bcd26616dbe7c9b5b0

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for bhmsh-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ff093ff09e02d7218438e12300ae1be6cce1098c9ace774db31b3cb70a160c3a
MD5 59fb612b0c6dc83f6f4cf8c7c5662e8b
BLAKE2b-256 b5e7e25338336335410cc8ca0b53e97073af3d1ce3e14ee1f4fce559ed90dc5e

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