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.3.tar.gz (15.8 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.3-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: folderbot-0.1.3.tar.gz
  • Upload date:
  • Size: 15.8 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.3.tar.gz
Algorithm Hash digest
SHA256 a16ca407e8a9b432b8c0138b4293c08cb47968f11521c399cda1b8d55baa526b
MD5 30ef05da31272eea0f6ba2d36fc2516c
BLAKE2b-256 eb67d2c1c3596267df3eda05ad0a676bac09e9408159977d845f75051cb1a4a3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: folderbot-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 14.0 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d82468f52adb1227576d5ebf14c8ab800b84e310d86fb7bbce45d36c09135adb
MD5 e0eec1dd9514f8379f1958a2bf3de80f
BLAKE2b-256 44f2c5be19e69009d315e3344f3bbba4c36e14a9695345394526743935c3261f

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