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.11.tar.gz (22.0 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.11-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: folderbot-0.1.11.tar.gz
  • Upload date:
  • Size: 22.0 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.11.tar.gz
Algorithm Hash digest
SHA256 09c542fbb446098211786737bd5f003649c2f209f6f51eb8f16f56d6ebdbb29f
MD5 f919f5aa66d9f019fc1b656b846f5669
BLAKE2b-256 5390082a0ee3480d79406de4a40131dd9ba2ea6833ded09ea3b59637410854c4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: folderbot-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 16.8 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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 330dd90919ea9b247fc9097302a308780a5660532a2ebef8d550d8aafd0329f0
MD5 b8ae6ccc7302f41d023d8fc2460ea73d
BLAKE2b-256 a6bb45d1abceb139f4803e31d7e304038a765bf1d88e2b445dce5520ae851ceb

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