hermitd

Name	hermitd JSON
Version	0.2.0 JSON
	download
home_page	None
Summary	llm-powered shell assistant daemon
upload_time	2024-09-11 08:25:31
maintainer	None
docs_url	None
author	Max Yu
requires_python	>=3.9
license	Apache-2.0
keywords	llmsh llm shell bash copilot
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # hermitd
`hermitd` is the hermit crab living inside the shell, and just like a hermit, can give you useful suggestions :D

In all seriousness, `hermitd` is your llm-powered assistant/copilot to use with your shell. 

**NOTE**: `hermitd` is designed to be used along with `llmsh`, where `llmsh` wraps a shell of your choice (bash, csh, etc).

## Installation
You can install hermitd directly using 
```shell
pip install hermitd
```
Then you can install hermitd as a systemd service using
```shell
sudo hermitd-install
```

NOTE: as an alternative you can run directly using `OPENAI_API_KEY=xxx python3 hermitd -c <config-file>` or `ANTHROPIC_API_KEY=xxx python3 hermitd -c <config-file>`.

## Running Models Locally
You can run the following to install hermitd with additional dependencies needed for local model hosting, like pytorch and vLLM.
```shell
pip install hermitd[local]
```
Read [DEVELOPMENT.md](DEVELOPMENT.md) for more instructions

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "hermitd",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "llmsh, llm, shell, bash, copilot",
    "author": "Max Yu",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/ec/e9/a739c458efdc7bc7087bcacb13d34f3a524b7dcbf08adb876b75b7d0c5cf/hermitd-0.2.0.tar.gz",
    "platform": null,
    "description": "# hermitd\n`hermitd` is the hermit crab living inside the shell, and just like a hermit, can give you useful suggestions :D\n\nIn all seriousness, `hermitd` is your llm-powered assistant/copilot to use with your shell. \n\n**NOTE**: `hermitd` is designed to be used along with `llmsh`, where `llmsh` wraps a shell of your choice (bash, csh, etc).\n\n## Installation\nYou can install hermitd directly using \n```shell\npip install hermitd\n```\nThen you can install hermitd as a systemd service using\n```shell\nsudo hermitd-install\n```\n\nNOTE: as an alternative you can run directly using `OPENAI_API_KEY=xxx python3 hermitd -c <config-file>` or `ANTHROPIC_API_KEY=xxx python3 hermitd -c <config-file>`.\n\n## Running Models Locally\nYou can run the following to install hermitd with additional dependencies needed for local model hosting, like pytorch and vLLM.\n```shell\npip install hermitd[local]\n```\nRead [DEVELOPMENT.md](DEVELOPMENT.md) for more instructions\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "llm-powered shell assistant daemon",
    "version": "0.2.0",
    "project_urls": {
        "Repository": "https://github.com/maxyu1115/llmsh"
    },
    "split_keywords": [
        "llmsh",
        " llm",
        " shell",
        " bash",
        " copilot"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2237c52c3dca40d3d6669a08babd6b526a9b2ad004f1319a40d8a8737bb7745d",
                "md5": "49158de56a922d44668a5645992a3eb0",
                "sha256": "9b5f39f3856843193cf42e9005389b458c13e5bd27356cf4f85220314ad06c6a"
            },
            "downloads": -1,
            "filename": "hermitd-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "49158de56a922d44668a5645992a3eb0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 14464,
            "upload_time": "2024-09-11T08:25:30",
            "upload_time_iso_8601": "2024-09-11T08:25:30.397792Z",
            "url": "https://files.pythonhosted.org/packages/22/37/c52c3dca40d3d6669a08babd6b526a9b2ad004f1319a40d8a8737bb7745d/hermitd-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ece9a739c458efdc7bc7087bcacb13d34f3a524b7dcbf08adb876b75b7d0c5cf",
                "md5": "3efe5948b321028f1c2d337629361623",
                "sha256": "6f261cccbd058c16d338bf0712f6ef46c2dc87788d23879fa26b97985f680378"
            },
            "downloads": -1,
            "filename": "hermitd-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "3efe5948b321028f1c2d337629361623",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 14003,
            "upload_time": "2024-09-11T08:25:31",
            "upload_time_iso_8601": "2024-09-11T08:25:31.992706Z",
            "url": "https://files.pythonhosted.org/packages/ec/e9/a739c458efdc7bc7087bcacb13d34f3a524b7dcbf08adb876b75b7d0c5cf/hermitd-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-11 08:25:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "maxyu1115",
    "github_project": "llmsh",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "hermitd"
}