Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/davidegat/laib-local-ai-bash

AI-powered Bash terminal built with Python, Tkinter, tkterm, using local LLM through LMStudio for natural language command generation; features whitelist/blacklist management, intuitive interface.
https://github.com/davidegat/laib-local-ai-bash

ai bash llm lmstudio local-ai local-llm local-llm-integration nlp python shell terminal tkinter tkterm

Last synced: 3 months ago
JSON representation

AI-powered Bash terminal built with Python, Tkinter, tkterm, using local LLM through LMStudio for natural language command generation; features whitelist/blacklist management, intuitive interface.

Awesome Lists containing this project

README 

          
# LAIB# Local AI Bash



## Overview

**LAIB# Local AI Bash** is an interactive terminal application that integrates a local AI model for natural language-based command generation. It includes features like whitelisting, blacklisting, and manual command review to ensure safety and usability. Currently, LAIB# has been tested only on Linux, but may work on other operating systems too, with small code changes.



### Key Features

- Generate commands using natural language queries.

- Uses local LLM Models (LMStudio https://lmstudio.ai/ required).

- Manage whitelisted (allowed) and blacklisted (blocked) commands.

- Review and edit blocked AI-generated commands before execution.

- Infinite loops and common 'bad' commands protection.

- Automatically execute generated commands in a real terminal.

- Integrated terminal for manual command entry.

- Other menus and search: Access menu for customization, and searching through terminal output.



![image](https://github.com/user-attachments/assets/a1a7cb1f-fce9-4b2f-a818-5774dbfee032)



![image](https://github.com/user-attachments/assets/cfbe47af-0797-425a-874b-cff46b85600a)



---



## Requirements

To use this application, ensure you have:



1. **Python 3.8+** installed on your system.

2. **LMStudio** running locally to interact with the AI model (https://lmstudio.ai/).

3. A LLM Model downloaded from LMStudio (see suggestions below).



### Suggested LMStudio Configuration

- LLM Model: `bashcopilot-6b-preview`

   -  This model is 'bash' oriented: it mostly generates the right command, but sometimes, on higher values, it will try to build scripts, or long oneliners.

   -  Other general bigger models, like Llama, may work better in understanding the exact command, and less better in bash scripting.

   -  Avoiding 'uncensored' models may prevent bad commands to be generated.



- These settings have been tested with good results on other models. As a general suggestion: keep values low, especially on bigger models:

   - Context Length: `200-400`

   - Temperature: `0.45 - 0.6`

   - Response Length Limit: `50-250 tokens`

   - Top-K Sampling: `40`

   - Repeat Penalty: `1.1`

   - Top-P Sampling: `0.95`

   - Minimum P Sampling: `0.05`



---



## Installation



1. **Clone the Repository**

```bash

$ git clone https://github.com/davidegat/LAIB-Local-AI-Bash.git

$ cd LAIB-Local-AI-Bash

```



2. **Set Up a Virtual Environment (Optional)**

```bash

$ python3 -m venv venv

$ source venv/bin/activate

```



3. **Install Required Libraries**

using the following command:

```bash

$ pip install tkinter requests tkterm

```

If not included in your installation, you may also need: `threading`, `os`, `re`, `json`, `queue`



4. **Install LMStudio**

- Download and install LMStudio.

- Download and load the suggested model.

- Configure LMStudio to run at `http://127.0.0.1:1234`.



You can also set your favourite LMStudio Endpoint via `settings` menu, to access a custom local or remote LMStudio API.



---



## Usage



### Starting the Application

Ensure LMStudio is running before starting the application. Then execute:

```bash

$ python laib.py

```



### Interface Overview

1. **Terminal Frame**: Interactive terminal for direct Bash commands and output display.

2. **Query Box**: Input natural language queries to generate commands.

3. **Menu Bar**:

   - **Settings**: Edit whitelist, blacklist, LMStudio Endpoint.

   - **Help**: Access user guide and about section.

   - **Debug**: Shows LMStudio console to monitor endpoint

5. **Reset Cache Button**: Clears AI command cache.

6. **Customization and Search**:

   - Use top-right menu to and search through terminal output.

   - Access context menu in terminal by right-clicking.



![image](https://github.com/user-attachments/assets/f0251779-786a-44cb-8a52-3f995dfff568)



### Example Workflow

1. Enter a query in the query box, e.g., `Show files in current dir`

2. AI will generate a command, which will be checked against whitelist/blacklist.

3. If approved, command is executed automatically in terminal.

4. If blocked, a review window allows you to edit or approve the command.

5. In some cases, command blocks are hardcoded (loops, sudo).



![image](https://github.com/user-attachments/assets/35ed6b85-2220-40d2-a8e6-765fbc0a3855)



![image](https://github.com/user-attachments/assets/81f21432-f33b-40fd-a357-6e037195a493)



![image](https://github.com/user-attachments/assets/97638461-9432-4c45-b805-ffc46718d8d8)



### Command Management

- **Whitelist**: Commands that bypass review and execute directly.

- **Blacklist**: Commands requiring review before execution.

- Access these lists from `Settings` menu.



![image](https://github.com/user-attachments/assets/35948968-dd64-40bd-b354-e2a73f896439)



---



## Advanced Features



### Command Cache

- Temporarily stores generated commands for faster reuse.

- Use `Reset Cache` button to clear this cache.



### Safety Notes

- **Use at own risk**: most dangerous commands are blocked, but **no one can guarantee that all AI generated commands will do no harm**. Do not use on important or production contexts! 

- Commands starting with `sudo` are not supported by tkterm library and are blocked for safety.

   - Run this software as root instead (not recommended).

- Direct input in terminal bypasses safety checks; use with caution.

- Supported Shells: Currently, only Bash is supported. Other interpreters or shells you will select by terminal menu may not function correctly with this application.

- Infinite loops are not supported, so blocked before being executed.



![image](https://github.com/user-attachments/assets/63e7c2be-7992-4a89-903f-2bdd12e781f5)



![image](https://github.com/user-attachments/assets/3cbd3a13-11a3-4e78-b91c-123064a4383e)



---



## Troubleshooting



### Common Issues

1. **AI not responding**: Ensure LMStudio is running and accessible at `http://127.0.0.1:1234`, check if model is loaded and its settings, or check LMStudio endpoint under `settings`.

2. **Command not executing**: Check if command is in blacklist.

3. **Sudo commands not allowed**: These are generally blocked, run software as root if needed.

4. **API Console**: Available under `debug` menu to monitor LMStudio endpoint.



![image](https://github.com/user-attachments/assets/1f4ab2e1-b2c1-4fc7-a92c-0b0c67a724ca)



---



## Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.

2. Create a new branch for your feature/bugfix.

3. Submit a pull request with a detailed explanation of changes.



---



## License

This project is Open Source. See the [LICENSE](LICENSE) file for details.



---



Software is provided as-is. By using it, you accept to take all responsibility for any damage of any kind this software may cause to your data, device(s), firm, corporation, shop, family, friends, whole life, belongings, backyard, dignity, and other moral and psychological stuff, your body or your cats'.