Tusho Documentation
Tusho is a beginner-friendly but production-minded file catalog project for Linux. It combines a C++ crawler with a PHP web interface so you can index a machine’s files and then search or browse them through a browser.
What you should read first
- If you are completely new, start with Getting Started.
- If you want the shortest possible command checklist, read Local Workflow.
- If you want to see the system in motion quickly, jump to First Crawl.
- If you want to understand the moving parts before you run anything, read Architecture.
Learning path for beginners
- Read the overview in Getting Started.
- Skim Local Workflow and keep it open in another tab while you work.
- Follow First Crawl.
- Follow Web Search.
- Read Database Schema to see what data is captured.
- Read Logging and Operations to understand observability.
- Read Testing and Quality to see how the repository protects itself.
Documentation layers
- Markdown docs in this site explain concepts and workflows.
- Doxygen-generated API reference explains the C++ interfaces in code-level detail.
- The separate wiki layer exists for slower, more tutorial-style learning.