Capcat Documentation

Complete reference documentation and user guides for Capcat.

Available Tutorials

User Tutorials

Practical, usage-focused guides for daily operations:

• Getting Started

  - First 5 minutes with Capcat

• Daily Workflow

  - News collection routines

• Interactive Mode

  - Visual menu system

• Managing Sources

  - Add/remove/test sources

• Bundles

  - Organize sources efficiently

• Customizing Output

  - Control what you collect

Comprehensive Technical References

Complete function-by-function references for advanced users and developers:

1. CLI Commands Reference

   - Every CLI command with ALL options and flags

2. Interactive Mode Complete Reference

   - Every menu, option, and workflow

3. Configuration Complete Reference

   - Every configuration option and file

4. Source System Complete Reference

   - Every source operation and type

5. API Functions Complete Reference

   - Every API function with parameters

How to Use These Tutorials

These tutorials are exhaustive technical references, not introductory guides. They document:

• Every function signature with complete parameter lists
• Every command-line option and flag
• Every configuration field and value
• Every workflow step-by-step
• Every error condition and handling
• Every API endpoint and method

For quick start information, see the main documentation. These tutorials are for complete system understanding.

Reading Order

Recommended order for comprehensive understanding:

For Users:

1. CLI Commands Reference (01)
2. Interactive Mode Reference (02)
3. Configuration Reference (03)

For Developers:

1. Source System Reference (04)
2. API Functions Reference (05)
3. Source Development Guide (06)

For Advanced Users:

1. Media Processing Reference (07)
2. Testing Reference (08)
3. Error Handling Reference (09)

For System Architects:

1. Performance and Monitoring (10)
2. Template System Reference (11)
3. Privacy and Anonymization (12)

Documentation Standards

Every tutorial follows these standards:

• Complete function signatures with type annotations
• Comprehensive parameter documentation
• Every possible option and flag documented
• Real terminal output examples (no emojis, factually accurate)
• Cross-references to source code locations
• Complete error condition documentation

Source Code References

All documentation references actual source code with file paths in Application/file format.