Metadata-Version: 2.1
Name: hermitd
Version: 0.2.0
Summary: llm-powered shell assistant daemon
Author: Max Yu
License: Apache-2.0
Project-URL: Repository, https://github.com/maxyu1115/llmsh
Keywords: llmsh,llm,shell,bash,copilot
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Operating System :: POSIX :: Linux
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: jinja2
Requires-Dist: pydantic
Requires-Dist: pyyaml
Requires-Dist: pyzmq
Requires-Dist: openai
Requires-Dist: anthropic
Provides-Extra: local
Requires-Dist: vllm>=0.5.3; extra == "local"
Requires-Dist: transformers; extra == "local"

# 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
