Obsidian Debug Bundle
Overview
Collect all necessary diagnostic information for Obsidian plugin bug reports and support requests.
Prerequisites
- Obsidian plugin with issues
- Access to vault configuration
- Terminal/command line access
Instructions
Step 1: Create Debug Bundle Script
Step 2: Collect System Information
Step 3: Collect Plugin Information
Step 4: Collect Vault Information
Step 5: Collect Error Logs (from Console)
For full implementation details and code examples, load:
references/implementation-guide.md
Output
obsidian-debug-YYYYMMDD-HHMMSS.tar.gzarchive containing:summary.txt- System and plugin infomanifest.json- Plugin manifesttsconfig.json- TypeScript configurationconsole-log.txt- Console output (manual)plugin-data.json- Sanitized plugin data
Error Handling
| Item | Purpose | Privacy |
|---|---|---|
| System info | Environment check | Safe |
| Plugin manifest | Version/config | Safe |
| Dependencies | Compatibility | Safe |
| Console logs | Error messages | Review before sharing |
| Settings | Configuration | REDACT secrets |
| Vault path | Location | DO NOT share |
Resources
Next Steps
For rate limit issues, see obsidian-rate-limits.
Examples
Basic usage: Apply obsidian debug bundle to a standard project setup with default configuration options.
Advanced scenario: Customize obsidian debug bundle for production environments with multiple constraints and team-specific requirements.