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.5.tar.gz (85.9 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.5-py3-none-any.whl (113.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sarathy-0.1.5.tar.gz
  • Upload date:
  • Size: 85.9 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.5.tar.gz
Algorithm Hash digest
SHA256 911a9d7579794a9c7087e35cbd947c3517c9126261d317a99b7a5ff512869f53
MD5 860634d6395b258c5f239e791bbece73
BLAKE2b-256 37caf1076665cd05304682a6858d1c6a50fa163b22f519a51252686c4e0edb2e

See more details on using hashes here.

Provenance

The following attestation bundles were made for sarathy-0.1.5.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.5-py3-none-any.whl.

File metadata

  • Download URL: sarathy-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 113.1 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1d31fb4a19a26de90c9cc28e734ce7f8f34d9fccfd2ed288ebb6dc5baba3f064
MD5 37c86307a39c2ac27577b3d337f4d47c
BLAKE2b-256 b0c1d489ae85513f32ec1c26fbb12c2fc5280a2f36dc0c56399b9e010d657b69

See more details on using hashes here.

Provenance

The following attestation bundles were made for sarathy-0.1.5-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