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.2.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.2-py3-none-any.whl
(14.0 kB
view details)
File details
Details for the file folderbot-0.1.2.tar.gz.
File metadata
- Download URL: folderbot-0.1.2.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 |
9b8a5e18338e1597791f9f7d856f63474127c4845c6dd2f4d4c25b81c914f0fa
|
|
| MD5 |
5897d0d2dbae63ad9147d62fe7d5fcd7
|
|
| BLAKE2b-256 |
8611b808f84b8bce3c5fcdc0a8abdd3a7060897e07ba3e5a1aef0893976b91f8
|
File details
Details for the file folderbot-0.1.2-py3-none-any.whl.
File metadata
- Download URL: folderbot-0.1.2-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 |
b1ac73e5925f9a470ddfdd31b34c59b13557cc3aa23921a3c50fffb4b03d26bd
|
|
| MD5 |
4ac477416e1bbf3d426b6852813c8252
|
|
| BLAKE2b-256 |
b4bebb38ecb98682e49141cc98fa5c318461a3f8b94133fa480aa1cf54172706
|