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

Uploaded Python 3

File details

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

File metadata

  • Download URL: folderbot-0.1.5.tar.gz
  • Upload date:
  • Size: 16.7 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.5.tar.gz
Algorithm Hash digest
SHA256 3fb464ac38b119110036de85acc2ef4a7fb8d790954bf4f322614e40a4e0017f
MD5 a3509952afbb64cf8a25c31ff5e2fd5c
BLAKE2b-256 bcf6f1538aaf9a94bee34b8929c792ad1eb882c1887f46d6068e0f45608af29c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: folderbot-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 14.2 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 cc8fd56943a4a0c10ba0d472e557f0914d5a6151d2fe6fd0454df0fa699421e0
MD5 9c7293b35e87d622325138a6dbc4385a
BLAKE2b-256 c81a2cf1535e65337321d8fc8d3036510a98444f2b24af60cc498cb19121bd40

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