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.12.tar.gz (28.2 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.12-py3-none-any.whl (21.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: folderbot-0.1.12.tar.gz
  • Upload date:
  • Size: 28.2 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.12.tar.gz
Algorithm Hash digest
SHA256 ba008ba040b28d63126321b35aae1ed79e65e8313f41bf8f5603fc95db87b16a
MD5 13a68a769a49256d40c56b3329642b94
BLAKE2b-256 01c9c70ab232eefbb3b93b8d8df9d58f039690d8ceb44a1d76f33f409870f9b5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: folderbot-0.1.12-py3-none-any.whl
  • Upload date:
  • Size: 21.5 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.12-py3-none-any.whl
Algorithm Hash digest
SHA256 5717e30df03a4e4c19886fcf2858f823f23d6d803393694218efb0d52548db54
MD5 0e9b2b9083b811676fe884c90cdcbb08
BLAKE2b-256 c44a94b0b4d621d627c4bfd8ffd8d0fc80e387bc08e6331ee10cc7168795e8b7

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