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
Release history Release notifications | RSS feed
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.9.tar.gz
(19.4 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
folderbot-0.1.9-py3-none-any.whl
(15.9 kB
view details)
File details
Details for the file folderbot-0.1.9.tar.gz.
File metadata
- Download URL: folderbot-0.1.9.tar.gz
- Upload date:
- Size: 19.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.2.0 CPython/3.13.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f815284a529e5f495e472c412b8590903e577dfd4d24d5bfe49dc77d71088da3
|
|
| MD5 |
7549b67c61e5e3b103d37ea91d57156d
|
|
| BLAKE2b-256 |
22264990614db93a8df2016924d3d159cf28f2a9c6c620ac5359e72cd95e41c8
|
File details
Details for the file folderbot-0.1.9-py3-none-any.whl.
File metadata
- Download URL: folderbot-0.1.9-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8fadab8c347881a5bdf818aff6d1be51ba852674560e16c11a61ef455d228e08
|
|
| MD5 |
9610307910bf1664c0a90e837ede8c5b
|
|
| BLAKE2b-256 |
b5b206c17da37fa0240fcac174999233da3247aeb79a0ee44a455b1d14b89f2c
|