SnapShell

SnapShell is a powerful command-line utility designed to enhance your Linux terminal experience by auto-completing commands using a Language Learning Model (LLM). SnapShell intelligently suggests commands based on your input, maintains a history of suggested commands, and allows you to manage your command history with ease.

Features

• Informed Sugestion: Get AI-powered command suggestions based on the query and your system's installed packages.
• Command History: Review previously suggested commands at any time.
• History Management: Clear the command history with a single command.
• Database Update: Easily update the database with the installed packages on your system.

Installation

Prerequisites

• Python 3.10 or higher
• pip package manager

Installing via pip

Install SnapShell with the following command:

pip install snapshell

Custom Installation

SnapShell requires your Groq Api key during installation. Follow the on-screen instructions after installation

The installation will automatically store the key in ~/.snapshell_config.json file.

OR

git clone https://github.com/KTS-o7/snapshell.git
cd snapshell
python -m venv env
source env/bin/activate
pip install -r requirements.txt
python setup.py install

Dependencies

SnapShell requires the following libraries:

• argparse: For parsing command-line arguments.
• sqlite3: For local database operations.
• os: To interact with your operating system.

Configuration Instructions

To use SnapShell, you need to provide GROQ_API_KEY when prompted for the first time. For any changes in the key you can edit ~/.snapshell_config.json file and add the appropriate key.

Usage

Run SnapShell in your terminal using:

snapshell

Command-line Arguments

SnapShell supports the following arguments:

• --update-db: Updates the database with currently installed packages.
• --view-history: Displays the command suggestion history.
• --clear-history: Clears all entries from the command history.

Example usage:

snapshell --update-db
snapshell --view-history
snapshell --clear-history

Advanced Usage

SnapShell is intuitive and primitive to use. It suggests commands based on your input and maintains a history of suggestions. You can view or clear the command history at any time.

How It Works

SnapShell leverages a Language Learning Model to suggest relevant Linux commands based on user input. It keeps a local history of suggestions that can be reviewed or cleared at your discretion. Upon installation, SnapShell can update its internal database with packages installed on your system, ensuring up-to-date suggestions.

Functions

• view_history(): Fetch and display the command history from the local database.
• clear_history(): Clear the command history in the local database.
• main(): The primary function that handles user input, command-line arguments, and interaction.

API Documentation

SnapShell does not directly expose API endpoints, but it interacts with the GROQ API under the hood. Here’s a brief overview:

• GROQ API Key: Used to authenticate the SnapShell tool.
• Command Suggestions: SnapShell queries the GROQ API with the user's input to retrieve command suggestions in real-time. If the project exposes new APIs in the future, detailed endpoint documentation should be added here.

Contributing

We welcome contributions! If you'd like to contribute, please follow these steps:

1. Fork the repository:Click the "Fork" button at the top of the GitHub repository page.
2. Create a branch: Create a new feature or bugfix branch.

git checkout -b feature/new-feature

3. Code Style: Follow PEP 8 guidelines for Python code.
4. Testing: Ensure your code passes all existing tests and add new tests if necessary.
5. Submit a Pull Request: Once your changes are ready, submit a pull request for review.

We currently need help to integrate SnapShell with more shells and support more platforms like windows.

Troubleshooting

Common Issues

1. Installation Errors: Ensure that you have the correct version of Python and pip installed. If dependencies fail to install, try updating pip:

pip install --upgrade pip

1. Missing GROQ_API_KEY: If SnapShell is not functioning properly, make sure the api-key is correctly set in config. You can check this by running:

cat ~/.snapshell_config.json

3. Permission Denied: If you encounter a "permission denied" error, try running the command with sudo or ensure you have the necessary file permissions.
4. Clearing History Not Working: If the history isn’t clearing, you might need to manually reset the SQLite database file used by SnapShell:

rm ~/.snapshell/system_info.db

If you encounter other issues, feel free to open an issue in the GitHub repository or contact us.

License

SnapShell is licensed under the MIT License. For more details, see the LICENSE file.

Contact

For any questions, issues, or feature requests, please reach out to:

Krishnatejaswi S
[email protected]

Contributors

• Nihaal SP