Skip to main content

Sarathy : My Personal _claw style_ Assistant

Project description

sarathy

Sarathy : My Personal Assistant

PyPI Python License

Who is Sarathy and Why ?

Sarathy is my own AI assistant implementation focused on local models. Frustrated with bloated alternatives and API costs, I built this to run 100% offline with only the features I need.

Sarathy means helper, guide, driver, mentor in both Sanskrit & Tamil.

Supported Models

Local Providers (Primary)

  • Ollama - http://localhost:11434
  • LMStudio - http://localhost:1234/v1
  • vLLM - any OpenAI-compatible local endpoint

Custom Endpoints

  • Custom - any OpenAI-compatible API (local or cloud)

Supported Channels

Channel Description
Telegram Bot via @BotFather
Discord Bot via Discord Developer Portal
Email IMAP/SMTP

Installation

Install from source (latest features, recommended for development)

git clone https://github.com/kspviswa/sarathy.git
cd sarathy
pip install -e .

Install with uv (stable, fast)

uv tool install sarathy

Install from PyPI (stable)

pip install sarathy

Quick Start

[!TIP] Make sure you have Ollama, LMStudio, or vLLM running before starting Sarathy.

1. Initialize

sarathy onboard

2. Configure (~/.sarathy/config.json)

Example for Ollama:

{
  "agents": {
    "defaults": {
      "model": "llama3"
    }
  },
  "providers": {
    "ollama": {}
  }
}

Example for LMStudio:

{
  "agents": {
    "defaults": {
      "model": "llama-3-8b"
    }
  },
  "providers": {
    "lmstudio": {}
  }
}

Example for Custom (e.g., local vLLM or other OpenAI-compatible):

{
  "agents": {
    "defaults": {
      "model": "llama-3-70b-instruct"
    }
  },
  "providers": {
    "custom": {
      "apiBase": "http://localhost:8000/v1"
    }
  }
}

3. Chat

sarathy agent -m "Hello!"

Or start the gateway for multi-channel support:

sarathy gateway

CLI Reference

Command Description
sarathy onboard Initialize config & workspace
sarathy agent -m "..." Chat with the agent
sarathy agent Interactive chat mode
sarathy gateway Start the gateway (Telegram/Discord/Email)
sarathy status Show status

Interactive mode exits: exit, quit, /exit, /quit, :q, or Ctrl+D.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sarathy-0.1.3.tar.gz (80.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sarathy-0.1.3-py3-none-any.whl (106.6 kB view details)

Uploaded Python 3

File details

Details for the file sarathy-0.1.3.tar.gz.

File metadata

  • Download URL: sarathy-0.1.3.tar.gz
  • Upload date:
  • Size: 80.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sarathy-0.1.3.tar.gz
Algorithm Hash digest
SHA256 9974ef8412e8d917436e961819c7f0c9cb6a932246ff29638835a833017419f9
MD5 03295973a75c6701af050bf8bbc9395b
BLAKE2b-256 6b02a79dd8ca44d562468b947bc5ea5e817f8431863d3a1f3337a89cdcd8ca59

See more details on using hashes here.

Provenance

The following attestation bundles were made for sarathy-0.1.3.tar.gz:

Publisher: python-publish.yml on kspviswa/sarathy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sarathy-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: sarathy-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 106.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sarathy-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 86eae522ad847a42fd85b17db7f78b4ff667dab831c1cdd6fd93bd3320787567
MD5 b91fec7475159cf5a597e569998f6cbe
BLAKE2b-256 ba63ebb753b3d323384b99c803c9ea958141c4dfad974964e19971614b0b6474

See more details on using hashes here.

Provenance

The following attestation bundles were made for sarathy-0.1.3-py3-none-any.whl:

Publisher: python-publish.yml on kspviswa/sarathy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page