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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: bhmsh-1.0.2.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.0.2.tar.gz
Algorithm Hash digest
SHA256 4b3fcde6e2e69eb247ed539ab2007b6301eca20bc55bcd8bc02ee4ade79fd534
MD5 e9893078f91643afb211cc502c1da8a5
BLAKE2b-256 3dac90c853767b132f38ba43a146f71f5d45b0e210d669e7d2d2ae24a3274017

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bhmsh-1.0.2-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.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 73ef043b3d9408dd7786418d1eb074c017890affb1f0fc5b5061a9267994f641
MD5 f12c70b0d32d93b7764ad343025c132c
BLAKE2b-256 c7495cf9a864ad11eb14161097ab03fe8890389762df0e871738211546af96e3

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