Skip to main content

Telegram bot for chatting with your folder using Claude AI

Project description

Folderbot

A Telegram bot that lets you chat with your folder using Claude AI.

Features

  • Pre-loaded context: Configure which files to include via glob patterns
  • Persistent sessions: Conversation history stored in SQLite
  • Auto-logging: All conversations logged to markdown files
  • Access control: Whitelist specific Telegram user IDs

Installation

pip install folderbot

Or install from source:

git clone https://github.com/jcardona/folderbot
cd folderbot
pip install -e .

Configuration

Create folderbot/config.yaml:

telegram_token: "YOUR_TELEGRAM_BOT_TOKEN"
anthropic_api_key: "YOUR_ANTHROPIC_API_KEY"
allowed_user_ids:
  - 123456789  # Your Telegram user ID

root_folder: /path/to/your/folder

read_rules:
  include:
    - "**/*.md"
    - "**/*.txt"
  exclude:
    - "**/docs/**"
    - ".git/**"

auto_log_folder: logs/

Get your Telegram user ID from @userinfobot.

Usage

Run directly

folderbot
# or
python -m folderbot

Run as systemd service

systemctl --user enable folderbot
systemctl --user start folderbot

Commands

  • /start - Initialize bot
  • /clear - Clear conversation history
  • /new - Start new topic
  • /status - Show session info
  • /files - List files in context

Development

pip install -e ".[dev]"
pytest

License

MIT

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

folderbot-0.1.8.tar.gz (19.3 kB view details)

Uploaded Source

Built Distribution

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

folderbot-0.1.8-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

Details for the file folderbot-0.1.8.tar.gz.

File metadata

  • Download URL: folderbot-0.1.8.tar.gz
  • Upload date:
  • Size: 19.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for folderbot-0.1.8.tar.gz
Algorithm Hash digest
SHA256 12fba02cb78e9720985e9465f3eaefe9151022bfecdd9f1f2d12faecf2ef339d
MD5 863087a11af6c285c80747027874da64
BLAKE2b-256 ceabf9845c747e6aa23c13b91dd7030522964d8a6ce4d914c695ce3da3e0f4e2

See more details on using hashes here.

File details

Details for the file folderbot-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: folderbot-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 15.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for folderbot-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 3dae040f16ae3fe284c5194b30229f9e6446a1e255dac9df67dde7337125060e
MD5 a0616813c33b1493571b89c6f5ef0414
BLAKE2b-256 f180769b944ae2610d74bc8cf54ddd2247e013b89b2e36a64137cbe98fa55593

See more details on using hashes here.

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