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.10.tar.gz (19.5 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.10-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: folderbot-0.1.10.tar.gz
  • Upload date:
  • Size: 19.5 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.10.tar.gz
Algorithm Hash digest
SHA256 12775a6f71205fb9e452e1829968b5621f5cc3690793b211efc60579c9ed35d6
MD5 249509e9f292c2b026589f741837146d
BLAKE2b-256 50ceda15d85d8345d29d589476a30f4a4f4fbe7f8f8a228c35bffef8438cd73a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: folderbot-0.1.10-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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 340496056df64de21bfb08698ed483905da862c4b3048cc0bfc1643ea89d0277
MD5 91f5ffefdfe4c8737e399b962b81df19
BLAKE2b-256 2becf1b37b0e1ab0601a644b46021a0c0c0d988df4342850d0e31eb738dfcc0e

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