Skip to main content

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

Now install BourguibaGPT with:

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bourguibagpt-1.7.5.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bourguibagpt-1.7.5-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file bourguibagpt-1.7.5.tar.gz.

File metadata

  • Download URL: bourguibagpt-1.7.5.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for bourguibagpt-1.7.5.tar.gz
Algorithm Hash digest
SHA256 972442e0ea248f50e59b1e7388ac0263c44d8d9759d37aa6dc3d9f2204734a12
MD5 e181c127ea182cd3d0a8842cdbfc81eb
BLAKE2b-256 faf89905e549c1e41aa639f6112962e3de4441c8947ddcd58ce1ce0a91ef4060

See more details on using hashes here.

File details

Details for the file bourguibagpt-1.7.5-py3-none-any.whl.

File metadata

  • Download URL: bourguibagpt-1.7.5-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for bourguibagpt-1.7.5-py3-none-any.whl
Algorithm Hash digest
SHA256 880775f1af111dc19554552ad9952679bd6af44947219524a5f447a1094cbb36
MD5 6285788f229dc760328c4326efcbabf9
BLAKE2b-256 99cf7c06a67ceb45aa21010440e3284d42e8d31fc047aa89987fd0b9dbc28255

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page