Metadata-Version: 2.4
Name: entityagent
Version: 0.1.3
Summary: Entity Agent: An AI assistant with platform interaction capabilities
Home-page: https://github.com/prakashsellathurai/entity
Author: Prakash Sellathurai
Author-email: prakashsellathurai@gmail.com
Project-URL: Source, https://github.com/prakashsellathurai/entity
Project-URL: Tracker, https://github.com/prakashsellathurai/entity/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: psutil
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Entity - A Cross-Platform LLM Agent

Entity is a Python-based AI agent designed to interact with your operating system, execute commands, and control programs across Windows, macOS, and Linux.


## Architecture
This agent uses a local Large Language Model (LLM) powered by Ollama. By default, it connects to a locally running Ollama server and uses the default model (e.g., `llama3`). All data and interactions remain private and on your local machine.

The core components are:
- **Agent Logic:** The main Python application that orchestrates tasks.
- **LLM Service:** An Ollama server running a local model (e.g., Llama 3).
- **Platform Interaction:** Modules for interacting with the specific operating system's terminal and applications.


## Getting Started
### Prerequisites

- Python 3.8+
- [Ollama](https://ollama.ai/) installed and running (default: `ollama serve`)
- A downloaded Ollama model (default: `llama3`, run `ollama run llama3` to download)



### Installation
#### From PyPI (recommended)

```bash
pip install entityagent
```

#### From source

```bash
git clone https://github.com/prakashsellathurai/entity
cd entity
pip install .
```


### Running the Agent (Default Ollama)


You can run the agent from the command line (it will use the default Ollama model):


```bash
entity-agent
```
or
```bash
python -m entityAgent.runtime
```
## TODO / Roadmap

- [ ] Allow configuration of LLM model (e.g., choose `llama3`, `mistral`, etc.)
- [ ] Add support for configuring LLM server URL/port
- [ ] Add UI options (CLI, Web, GUI)
- [ ] Add configuration file for user preferences
- [ ] Extend platform interaction capabilities



## Usage

You can interact with the agent in two ways:

1.  **Natural Language:**
    ```
    > Tell me a joke.
    > What is the capital of France?
    ```

2.  **Commands:**
    -   **Execute a shell command:**
        ```
        > run: ls -l
        ```
    -   **List running processes:**
        ```
        > run: list_processes
        ```

## Testing

To run the test suite, execute the following command:

```bash
pytest
```
