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.0.tar.gz
(15.8 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.0-py3-none-any.whl
(14.0 kB
view details)
File details
Details for the file folderbot-0.1.0.tar.gz.
File metadata
- Download URL: folderbot-0.1.0.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
09ab2ad1929f59fe3076be70d484ca306b18bbcb6870923336bf5df16dcbfe8b
|
|
| MD5 |
c7b4b9d19bc999abcd20611c14014783
|
|
| BLAKE2b-256 |
5dd233d09831384d24b865030e924e58cde892831e0c9a4b041c5a413d7c650b
|
File details
Details for the file folderbot-0.1.0-py3-none-any.whl.
File metadata
- Download URL: folderbot-0.1.0-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0efd707074424e1f19d2b7ae20843210545e79dbac4eb7670021679fb116abb5
|
|
| MD5 |
2089a20a1985978b47dcc76d6f75fbd7
|
|
| BLAKE2b-256 |
9422ee7250341fe8311c7ddf81f6d2a03336a607fb1ab9d1f41843215f4fbb56
|