ShellSpeak

ShellSpeak is an interactive command-line interface that enhances the terminal experience by integrating AI-driven command translation and execution. The core functionality of ShellSpeak revolves around capturing user input, translating it to actionable shell commands through an AI model, and executing these commands while displaying the output in a styled and user-friendly manner.

Notice

• This can and will delete files if you are not careful, I suggest you use this on a system you do not care about, or a emulator.
• I only have developed and tested on windows, "should" work with other consoles, and on windows, OpenAI loves using *nix comments.
• Feel free to look at what I have done, and please check back in a day or two.

Highlights

ShellSpeak Demo

• Now with the expanded space, and GPT JSON response reliability added.
• Works just like the console. (With pretty colors.)
• Embed files into you commands by using "file: /filepath/" (where "/filepath/" is the path to your file, allows for multiple files.)
• Uses past conversation history.
• Checks your PATH for all available commands, and implies default OS commands.
• Use plain text for commands i.e. "Go to folder Test"
• The modules/llm.py file has our LLM class, that allows for offline (huggingface.co transformers) and OpenAI (gpt3/gpt4), and can be easily expanded on.

(Files/History/PATH commands, are set to token limits that can be adjusted, check modules/shellSpeak.py)

Information

The above diagram illustrates the architecture of ShellSpeak. It provides an in-depth look into how the program captures and processes user input to execute commands. We have recently added the capability to handle file inputs and to manage command history, enhancing the overall user experience.

ShellSpeak Commands

• 'exit': to close ShellSpeak
• 'user: /command/': pass a raw command to execute then reply threw the AI
• 'file: /filepath/': adds file data to the command prompt. (can use multiple files, but will use the set token size for all files, files are also limited to 1,000,000 characters, due to calculating tokens. When trimming files we use Vector Matching, hopping to get relevant data from large data files.)
• 'clm': Clear command Memory
• 'about': Shows the About Information
• 'help': Shows this Help information.

Setup

1. Clone the repository:

   git clone https://github.com/TheCompAce/ShellSpeak
   cd ShellSpeak

2. Install the required dependencies:

   pip install -r requirements.txt

3. Configure your settings in settings.json to match your preferences and system setup.

Usage

Running the Script

Run the ShellSpeak script from the command line:

python main.py

This uses a menu to Setup and Run ShellSpeak.

Auto Run the ShellSpeak script from the command line:

python main.py /start

Runs with using the start menu, base on the settings.json that already exist.

(We have a run.bat, and ai_cmd.bat (auto run), that builds a environment, and runs "pip install -r requirements.txt")

Notes on settings.json

• the "prompt" values can be a string or a file path, if it is a file path then we use the file's data, this way we can have long prompts.
• the llm.py has a cache system, but it is mainly for debugging, and seems not to work well, as commands tend to be the same, but do different things.

Contribute

• You can join to help build the code base, or to mod the GitHub. (I do have another job, this is mainly for learning.)
• You can also donate (@BradfordBrooks79 on Venmo) if you want (I would love to do stuff like this full time.)

Contact

• First join our Discussion GitHub Discussion
• Then come join us over at Reddit

License

ShellSpeak is licensed under the Apache License 2.0. See the LICENSE file for details.