Skip to main content

bashtalk

This is a command-line interface application that records voice input, converts the voice input into text, and uses an OpenAI LLM (language model) to generate a bash script corresponding to the converted text. It provides options to customize the actions, such as skipping the LLM model, automatically running the generated script, and providing verbose output.

Requirements

Installation

Pip Installation

You can now install bashtalk directly from PyPI:

pip install bashtalk

Manual Installation

  1. Make sure you have Python 3.6 or above installed. You can check your Python version using the following command in the terminal:
    python --version
    
  2. Install the SoX from http://sox.sourceforge.net/.
  3. Clone the repository and navigate to its root directory.
  4. Install the package dependencies:
    pip install .
    
  5. Setup and authenticate the OpenAI Python client. For more details, checkout OpenAI Python client setup.
  6. Download and setup the LLM.

Usage

After installation, you can run bashtalk directly from the command line:

bashtalk -d ~/Documents -f audio.mp3 -m gpt-3.5-turbo -v

Here's a description of the various arguments:

  • -d, --dir_path (default: /tmp): Directory to save files
  • -f, --file_name (default: audio_record.mp3): Name of the audio file
  • -m, --model_name (default: gpt-3.5-turbo): LLM model name
  • -s, --skip_llm: Skip running the LLM model
  • -y, --auto_run: Automatically run the script without asking for confirmation
  • -v, --verbose: Verbose output
  • -c, --context_file: Context file for LLM prompt

Notes

This is a basic version of bashtalk. It uses external dependencies such as SoX, OpenAI, and LLM models. Please make sure that all dependencies are properly installed and setup. For more advanced usage, consider integrating it with other systems or extending it with more utility functions.

License

This project is licensed under the terms of the MIT license.

Metadata

Release files for bashtalk 0.0.1

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

Source distribution (sdist)

Source distribution for bashtalk 0.0.1
File Size Uploaded
bashtalk-0.0.1.tar.gz 3.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for bashtalk 0.0.1
File Interpreter ABI Platform
bashtalk-0.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 6.3 kB

Release files / bashtalk-0.0.1.tar.gz

Download URL bashtalk-0.0.1.tar.gz
Size 3.1 kB
Tags Source
SHA-256 checksum
How to use checksums
c55ffee7d75e59035c9c0573f931672147a35abdb89106f0c4279f8edde90931
BLAKE2b-256 checksum
How to use checksums
e2a2c18bd25f477ffdfba1a30254d5233486a4b196ffaa01e8cc84a941978461
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.12

Release files / bashtalk-0.0.1-py3-none-any.whl

Download URL bashtalk-0.0.1-py3-none-any.whl
Size 3.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a7f1a90f64a1499093bcffa759026f8e535bc756dc014ad903fc97555bf8cb78
BLAKE2b-256 checksum
How to use checksums
b5f6b06283b99eb3eb3b5ec2fbdf157e331e2420996f141b2b658a89786a934f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.12

Release history Release notifications | RSS feed

This release

0.0.1 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