Tunisian Shell Command Assistant
Project description
BourguibaGPT ๐น๐ณ
Your AI-Powered Tunisian Shell Command Assistant
Python Version: 3.6+
License: MIT
PyPI Version: Check Here
BourguibaGPT is an intelligent CLI tool that transforms natural language requests into safe shell commands using advanced AI models. Designed with a focus on safety and usability, it's your perfect companion for terminal productivity.
CLI Demo: View Image
Features โจ
- Natural Language Understanding ๐น๐ณ
Describe tasks in plain English, French, or Arabic (Tunisian dialect friendly!). - AI-Powered Command Generation ๐ค
Leverages local LLMs via Ollama (default: deepseek-r1:1.5b). - Safety First ๐
Multi-layer validation against dangerous commands. - Interactive CLI ๐ป
Rich terminal interface with syntax highlighting and progress indicators. - Command History ๐
Automatic tracking of generated commands with execution status. - Cross-Platform ๐
Supports Linux, macOS, and Windows Subsystem for Linux. - Smart Execution โก
Optional auto-execution with confirmation prompts.
Installation ๐ฆ
Step 1: Install Ollama (required)
Run the following command in the terminal:
curl -fsSL https://ollama.com/install.sh | sh
ollama pull deepseek-r1:1.5b
Step 2: Install BourguibaGPT
Run the following command in the terminal:
pip install bourguibagpt
Quick Start ๐
Run the command:
bourguibagpt
Example interaction:
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ Your Tunisian Shell Command Assistant โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
๐น๐ณ BourguibaGPT โ list all json files modified last week
Generated command: find . -name "*.json" -mtime -7
Execute? [yes/no]: yes
โ
Command executed successfully
Advanced Usage ๐ ๏ธ
Command Line Options
bourguibagpt [OPTIONS]
--model MODEL_NAMEโ Specify Ollama model (default: deepseek-r1:1.5b).--temperature FLOATโ Control creativity (0.1-1.0, default: 0.7).--auto-executeโ Auto-execute validated commands.--history-file PATHโ Custom command history location.
Manage History
Show last 10 commands:
bourguibagpt --history
Execute from history:
bourguibagpt execute "find . -name *.json -mtime -7"
Safety Measures โ ๏ธ
BourguibaGPT includes multiple protection layers:
- Pattern matching against dangerous commands (e.g.,
rm -rf /). - Command structure validation.
- Execution confirmation prompts.
- Restricted special characters handling.
- Model prompt engineering for safety.
Roadmap ๐บ๏ธ
- Browser-based GUI
- Command explanation mode
- Plugin system for custom validations
- Shared team history sync
- Alternative AI backend support
Contributing ๐ค
We welcome contributions! Please see our Contribution Guidelines (CONTRIBUTING.md) for details.
License ๐
This project is licensed under the MIT License - see the LICENSE file for details.
GitHub Repository: Visit Here
Report Issues: Submit Here
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file bourguibagpt-1.7.1.tar.gz.
File metadata
- Download URL: bourguibagpt-1.7.1.tar.gz
- Upload date:
- Size: 13.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c846015502b1971656b69793b95d286250d2c87396ee25855808022777a7a86e
|
|
| MD5 |
1b15bb0984227bb247f05f02a95f65c9
|
|
| BLAKE2b-256 |
0e406f60b235a3508e4e53f934785e4405ab5e2789f49349c105fe1b7b1459e1
|
File details
Details for the file bourguibagpt-1.7.1-py3-none-any.whl.
File metadata
- Download URL: bourguibagpt-1.7.1-py3-none-any.whl
- Upload date:
- Size: 13.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b02d20f327fe9072cb22892efd307f3636b64691485502dcf3d10e07e190431d
|
|
| MD5 |
1b0cac661f518a71d6cff6e7793ee486
|
|
| BLAKE2b-256 |
f9ee59662406c49597b691fcd246919318cc67b6e2d9694dad7e596eaf8df004
|