Folderbot

User Guide

  • Getting Started
    • Installation
    • Quick Start
    • Features
    • Running as a Service
  • Configuration
    • Basic Configuration
      • Required Fields
      • Optional Fields
    • Supported Providers
    • Read Rules
    • File Watching
    • Multi-Bot Configuration
    • Tool Configuration
      • Web Search
  • Built-in Tools
    • File Tools
    • Web Tools
    • Scheduler Tools
    • Upload Tools
    • Utility Tools
    • Activity & Monitoring Tools
    • Interactive Tools
  • Custom Tools
    • Basic Example
    • Required Interface
    • Factory Function
    • Package Structure
  • CLI Reference
    • Bot Management
    • Configuration
    • Folder Management
    • Systemd Service
    • Telegram Commands

Architecture

  • Folderbot Architecture
    • Overview
    • Request Lifecycle
      • Message Accumulation and Cancellation
    • Core Components
      • Telegram Handler (telegram_handler.py)
      • LLM Client (llm_client.py)
      • Agent Loop
      • Structured Response Models
    • Tool System
      • Registration
      • Tool Categories
      • Tool Configuration
      • Services Pattern
    • ask_user: Interactive User Input
      • Flow
      • Input Types
      • Key Design Decisions
    • Session Management
    • Topic-Based Conversation Management
    • Voice Transcription
    • Self-Update Mechanism
    • Todo Management
      • Markdown Format
      • Filtering
    • Calendar
    • Token Usage Tracking
    • Multi-Bot Service Support
    • Hallucination Guard
    • Roadmap
      • Sandboxed Python Execution (run_python tool)
      • LLM-Powered Todo Extraction with Section-Level Cache
      • Lightweight Voice Transcription
      • Homebrew Formula

API Reference

  • API Reference
    • Configuration
      • WatchConfig
      • ReadRules
      • migrate_yaml_to_toml()
      • find_config_path()
      • Config
    • LLM Client
      • trim_history_to_budget()
      • build_topic_history()
      • ToolCallRequest
      • AgentResponse
      • AskUserRequest
      • TokenUsage
      • LLMClient
    • Telegram Handler
      • TelegramBot
    • Session Manager
      • validate_topic_name()
      • Message
      • TopicReassignment
      • UploadRecord
      • TokenUsageRecord
      • SessionManager
    • Tools
      • Core
      • File Tools
      • Web Tools
      • Scheduler Tools
      • Upload Tools
      • Topic Tools
      • Utility Tools
      • Activity Log
    • Scheduler
      • TaskScheduler
      • TaskStore
      • TaskScheduler
      • ScheduleType
      • TaskStatus
      • TaskStep
      • Schedule
      • TaskResult
      • TaskPlan
      • TaskStore
Folderbot
  • Overview: module code

All modules for which code is available

  • folderbot.config
  • folderbot.llm_client
  • folderbot.scheduler.models
  • folderbot.scheduler.persistence
  • folderbot.scheduler.scheduler
  • folderbot.session_manager
  • folderbot.telegram_handler
  • folderbot.tools.activity_log
  • folderbot.tools.base
  • folderbot.tools.folder_tools
  • folderbot.tools.list_files
  • folderbot.tools.read_file
  • folderbot.tools.registry
  • folderbot.tools.scheduler_tools
  • folderbot.tools.search_files
  • folderbot.tools.topic_tools
  • folderbot.tools.upload_tools
  • folderbot.tools.utils
  • folderbot.tools.weather
  • folderbot.tools.web_fetch
  • folderbot.tools.web_search
  • folderbot.tools.write_file

© Copyright 2025, Jorge Cardona.

Built with Sphinx using a theme provided by Read the Docs.