Skip to content

User Guide

Welcome to the Mailslide user guide. Because of the many features, we have split the guide into multiple small topics:

📚 Guide Index

  • Getting Started & Installation Install dependencies (uv), initialize config files, and start using the system through TUI.
  • Configuration Explanation of config.yaml parameters, including source folders, output destinations, and LLM call modes.
  • TUI Guide How to navigate the Terminal User Interface, tabs, and configure plugins visually.
  • Plugins System Learn about built-in plugins (like write_file, event_table) and how to configure Prompt Profiles.
  • CLI & Advanced Usage Use the CLI mode for batch processes, Python import methods for developers, and Babel i18n instructions.
  • LLM Connection How to set up a completely private, local LLM for parsing emails without commercial APIs, or configure API keys for cloud-based services like OpenAI.