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.4.tar.gz (85.4 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.4-py3-none-any.whl (112.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sarathy-0.1.4.tar.gz
  • Upload date:
  • Size: 85.4 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.4.tar.gz
Algorithm Hash digest
SHA256 0dbad9df34019225176fc5e2d19f84ab0e1dc22ca989957323c7b84632162782
MD5 4d842b47a905be86142cff463c2c4a35
BLAKE2b-256 05872acd059cd184d81d0c5873427d1552bd0040bc0a792cc60453f17a757a76

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: sarathy-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 112.0 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 73eead05e6f19b90086a6508419f56ffc395ec6b04dcc17252a8b90aed28821f
MD5 404d6cdbb079349a6a19d09c6ea0b0e2
BLAKE2b-256 ba72fac94e5b628ea682ef02dc719c2b605e8d661087c24ff2d9e400a97b3cda

See more details on using hashes here.

Provenance

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