Skip to main content

Tunisian Shell Command Assistant

Project description

Bourguiba - Command Generation Library

Bourguiba is a Python library designed to generate shell commands based on natural language input. This tool leverages advanced machine learning models to understand user intent and produce valid shell commands, making it easier for users to interact with the command line.

Features:

  • Generates common shell commands based on user descriptions.
  • Includes a comprehensive list of 150 common commands.
  • Utilizes a pretrained GPT-2 model for command generation.
  • Supports fuzzy matching to improve command accuracy based on user input.
  • Simple command-line interface for easy usage.

Usage:

To use bourguiba, simply import the library and create an instance of the CommandGenerator class. You can then call the generate_command method with a description of the command you wish to create.

Example:

from bourguiba import CommandGenerator

generator = CommandGenerator()
command = generator.generate_command("I want to create a folder")
print(command)  # Output: mkdir [folder_name]

Contributing:

Contributions are welcome! If you would like to contribute to bourguiba, please fork the repository and submit a pull request.

License:

This project is licensed under the MIT License. See the LICENSE file for details.

Special thanks to the creators of the GPT-2 model and the developers of the transformers library, which make this project possible.

For more information, please visit the GitHub repository.


Feel free to modify any sections to better fit your preferences!

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.0.1.tar.gz (7.5 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.0.1-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for bourguibagpt-1.0.1.tar.gz
Algorithm Hash digest
SHA256 5ce073a5f08ab2dc80ff69b6ae97d40e4ccbf4d4eafb6c9f155dde92a94b6259
MD5 fe32022bd58882836f692f660b691855
BLAKE2b-256 15b2e182dfc39e5ad646f10a2c5aa8840b8e54c6886dceb7fe606164653e7368

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bourguibagpt-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.8 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.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 680c1eac2f3c26933ef702fe6dc265ca1a49b624c9eabc2e421e59173062918f
MD5 5bb0520efa1e529005dc30940a309895
BLAKE2b-256 13919a4946d886ed0772d8b7a0ef51e9ec413e5adcb26a58f46ced2a2a40f6c8

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