ShellMate

Name	ShellMate JSON
Version	1.0.7 JSON
	download
home_page	https://github.com/Mercurius13/ShellMate
Summary	ShellMate: A GPT-Powered CLI Tool for Explaining and Finding Shell Commands
upload_time	2024-02-10 13:52:38
maintainer
docs_url	None
author	Siddhant
requires_python	>=3.6
license
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # ShellMate: The AI-Powered CLI Assistant
## Hey Devs, Here's Something You'll Love!

Let's be real - we've all been there. Staring at the terminal, trying to remember that one Linux command. It doesn't matter if you're just starting out or if you've been in the game for years; sometimes those commands just slip your mind. And sure, you could open a browser, search through stacks of docs, but isn't that just... tedious? That's where ShellMate jumps in!

## The Real Problem? Our Forgetful Brains!

We're software developers. We write elegant code, tackle complex algorithms, and create amazing apps. But remembering every single command and its syntax? That's asking a bit much. Who hasn't forgotten a command or two, right? So, instead of losing time Googling or scrolling through manuals, why not have a quick, in-terminal helper? Enter ShellMate - your CLI's new best friend!


## Key Features
- AI-Powered Explanations: Understand any command in plain English with a simple query.
- All Platforms Welcome: Whether you're on Linux, Windows, or MacOS, it's got your back.
- Find Commands Fast: Describe what you want to do, and ShellMate will find the command for you.
- Stay in the Zone: All of this happens within your beloved terminal. No more context switching!
## How to Install

```bash
pip install shellmate
```

That's it! No complex setups, just a simple pip command.

# How to Use ShellMate

## Need a Command Reminder?
```bash
shellmate explain "ls -l" -os linux
```
## Looking for the Right Command?

```bash
shellmate find "how to see disk usage" -os windows
```
## Examples
```python
# Forgot how to list files in detail on Linux?
shellmate explain "ls -l" -os linux

# Need to check disk usage on Windows but can't remember how?
shellmate find "how to see disk usage" -os windows
```

## Join the Forgetful Devs Club!
We're all in this together - a community of brilliant minds who sometimes forget the basics. ShellMate isn't just a tool; it's our little helper in those "Oops, I forgot again" moments. So, embrace it, use it, and keep coding without those pesky interruptions!

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Mercurius13/ShellMate",
    "name": "ShellMate",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "Siddhant",
    "author_email": "siddhant@zodevelopers.com",
    "download_url": "https://files.pythonhosted.org/packages/6c/bd/1a6f709d4fd4d079b25781ff7c368e9148ecf86d62fbd56c2ee135ebaa15/ShellMate-1.0.7.tar.gz",
    "platform": null,
    "description": "# ShellMate: The AI-Powered CLI Assistant\r\n## Hey Devs, Here's Something You'll Love!\r\n\r\nLet's be real - we've all been there. Staring at the terminal, trying to remember that one Linux command. It doesn't matter if you're just starting out or if you've been in the game for years; sometimes those commands just slip your mind. And sure, you could open a browser, search through stacks of docs, but isn't that just... tedious? That's where ShellMate jumps in!\r\n\r\n## The Real Problem? Our Forgetful Brains!\r\n\r\nWe're software developers. We write elegant code, tackle complex algorithms, and create amazing apps. But remembering every single command and its syntax? That's asking a bit much. Who hasn't forgotten a command or two, right? So, instead of losing time Googling or scrolling through manuals, why not have a quick, in-terminal helper? Enter ShellMate - your CLI's new best friend!\r\n\r\n\r\n## Key Features\r\n- AI-Powered Explanations: Understand any command in plain English with a simple query.\r\n- All Platforms Welcome: Whether you're on Linux, Windows, or MacOS, it's got your back.\r\n- Find Commands Fast: Describe what you want to do, and ShellMate will find the command for you.\r\n- Stay in the Zone: All of this happens within your beloved terminal. No more context switching!\r\n## How to Install\r\n\r\n```bash\r\npip install shellmate\r\n```\r\n\r\nThat's it! No complex setups, just a simple pip command.\r\n\r\n# How to Use ShellMate\r\n\r\n## Need a Command Reminder?\r\n```bash\r\nshellmate explain \"ls -l\" -os linux\r\n```\r\n## Looking for the Right Command?\r\n\r\n```bash\r\nshellmate find \"how to see disk usage\" -os windows\r\n```\r\n## Examples\r\n```python\r\n# Forgot how to list files in detail on Linux?\r\nshellmate explain \"ls -l\" -os linux\r\n\r\n# Need to check disk usage on Windows but can't remember how?\r\nshellmate find \"how to see disk usage\" -os windows\r\n```\r\n\r\n## Join the Forgetful Devs Club!\r\nWe're all in this together - a community of brilliant minds who sometimes forget the basics. ShellMate isn't just a tool; it's our little helper in those \"Oops, I forgot again\" moments. So, embrace it, use it, and keep coding without those pesky interruptions!\r\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "ShellMate: A GPT-Powered CLI Tool for Explaining and Finding Shell Commands",
    "version": "1.0.7",
    "project_urls": {
        "Homepage": "https://github.com/Mercurius13/ShellMate"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "42e7b40d7992cd8295a4006410b73de64d5d6634bc7b1e2960a4433a2ce14667",
                "md5": "b83acef8ebe0072d3a11d9ad6aa44377",
                "sha256": "eab05f0c9b7dface861ac7f8f3afe22af334a994771530903077efe79eafd6a3"
            },
            "downloads": -1,
            "filename": "ShellMate-1.0.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b83acef8ebe0072d3a11d9ad6aa44377",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 5116,
            "upload_time": "2024-02-10T13:52:36",
            "upload_time_iso_8601": "2024-02-10T13:52:36.342236Z",
            "url": "https://files.pythonhosted.org/packages/42/e7/b40d7992cd8295a4006410b73de64d5d6634bc7b1e2960a4433a2ce14667/ShellMate-1.0.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6cbd1a6f709d4fd4d079b25781ff7c368e9148ecf86d62fbd56c2ee135ebaa15",
                "md5": "e8d817d89fcca8cabfff7a081060b7e3",
                "sha256": "6d88abc8637797df668894db23064ac0e18a2a114d0054beac07be3327e1e703"
            },
            "downloads": -1,
            "filename": "ShellMate-1.0.7.tar.gz",
            "has_sig": false,
            "md5_digest": "e8d817d89fcca8cabfff7a081060b7e3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 4611,
            "upload_time": "2024-02-10T13:52:38",
            "upload_time_iso_8601": "2024-02-10T13:52:38.125955Z",
            "url": "https://files.pythonhosted.org/packages/6c/bd/1a6f709d4fd4d079b25781ff7c368e9148ecf86d62fbd56c2ee135ebaa15/ShellMate-1.0.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-10 13:52:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Mercurius13",
    "github_project": "ShellMate",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "shellmate"
}