---
name: obsidian-debug-bundle
description: |
  Collect Obsidian plugin debug evidence for support and troubleshooting.
  Use when encountering persistent issues, preparing bug reports,
  or collecting diagnostic information for plugin problems.
  Trigger with phrases like "obsidian debug", "obsidian diagnostic",
  "collect obsidian logs", "obsidian support bundle".
allowed-tools: Read, Bash(grep:*), Bash(tar:*), Grep, Write
version: 1.0.0
license: MIT
author: Jeremy Longshore <jeremy@intentsolutions.io>
---

# 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
```bash
#!/bin/bash
# obsidian-debug-bundle.sh

BUNDLE_DIR="obsidian-debug-$(date +%Y%m%d-%H%M%S)"
mkdir -p "$BUNDLE_DIR"

echo "=== Obsidian Plugin Debug Bundle ===" > "$BUNDLE_DIR/summary.txt"
echo "Generated: $(date)" >> "$BUNDLE_DIR/summary.txt"
echo "" >> "$BUNDLE_DIR/summary.txt"
```

### Step 2: Collect System Information
```bash
# System info
echo "--- System Information ---" >> "$BUNDLE_DIR/summary.txt"
echo "OS: $(uname -s)" >> "$BUNDLE_DIR/summary.txt"
echo "OS Version: $(uname -r)" >> "$BUNDLE_DIR/summary.txt"
echo "Node.js: $(node --version 2>/dev/null || echo 'not installed')" >> "$BUNDLE_DIR/summary.txt"
echo "npm: $(npm --version 2>/dev/null || echo 'not installed')" >> "$BUNDLE_DIR/summary.txt"
echo "" >> "$BUNDLE_DIR/summary.txt"
```

### Step 3: Collect Plugin Information
```bash
# Plugin directory (adjust path as needed)
PLUGIN_DIR="/path/to/your/plugin"

# Plugin metadata
echo "--- Plugin Information ---" >> "$BUNDLE_DIR/summary.txt"
if [ -f "$PLUGIN_DIR/manifest.json" ]; then
  echo "Manifest:" >> "$BUNDLE_DIR/summary.txt"
  cat "$PLUGIN_DIR/manifest.json" >> "$BUNDLE_DIR/summary.txt"
  cp "$PLUGIN_DIR/manifest.json" "$BUNDLE_DIR/"
fi
echo "" >> "$BUNDLE_DIR/summary.txt"

# Package versions
if [ -f "$PLUGIN_DIR/package.json" ]; then
  echo "--- Dependencies ---" >> "$BUNDLE_DIR/summary.txt"
  cat "$PLUGIN_DIR/package.json" | grep -A 50 '"dependencies"' | head -60 >> "$BUNDLE_DIR/summary.txt"
  echo "" >> "$BUNDLE_DIR/summary.txt"
fi

# TypeScript config
if [ -f "$PLUGIN_DIR/tsconfig.json" ]; then
  cp "$PLUGIN_DIR/tsconfig.json" "$BUNDLE_DIR/"
fi
```

### Step 4: Collect Vault Information
```bash
# Vault information (adjust path)
VAULT_DIR="$HOME/ObsidianVault"

echo "--- Vault Information ---" >> "$BUNDLE_DIR/summary.txt"
if [ -d "$VAULT_DIR/.obsidian" ]; then
  echo "Vault exists: YES" >> "$BUNDLE_DIR/summary.txt"

  # Installed plugins (names only, no sensitive data)
  echo "Installed plugins:" >> "$BUNDLE_DIR/summary.txt"
  ls "$VAULT_DIR/.obsidian/plugins/" 2>/dev/null >> "$BUNDLE_DIR/summary.txt"

  # Enabled plugins
  if [ -f "$VAULT_DIR/.obsidian/community-plugins.json" ]; then
    echo "Enabled plugins:" >> "$BUNDLE_DIR/summary.txt"
    cat "$VAULT_DIR/.obsidian/community-plugins.json" >> "$BUNDLE_DIR/summary.txt"
  fi
fi
echo "" >> "$BUNDLE_DIR/summary.txt"
```

### Step 5: Collect Error Logs (from Console)
```markdown
## Manual Console Log Collection

1. Open Obsidian
2. Press Ctrl/Cmd+Shift+I to open Developer Tools
3. Go to Console tab
4. Right-click in console area
5. Select "Save as..." → save to debug bundle directory
6. Name it "console-log.txt"
```

### Step 6: Collect Plugin Data (Sanitized)
```typescript
// Add to your plugin for debug export
export function exportDebugData(plugin: Plugin): object {
  return {
    pluginId: plugin.manifest.id,
    pluginVersion: plugin.manifest.version,
    obsidianVersion: process.versions?.electron ? 'desktop' : 'mobile',
    settings: sanitizeSettings(plugin.settings),
    timestamp: new Date().toISOString(),
  };
}

function sanitizeSettings(settings: any): any {
  const sanitized = { ...settings };
  // Remove sensitive fields
  const sensitiveKeys = ['apiKey', 'token', 'password', 'secret'];
  for (const key of sensitiveKeys) {
    if (key in sanitized) {
      sanitized[key] = '[REDACTED]';
    }
  }
  return sanitized;
}
```

### Step 7: Package Bundle
```bash
# Create archive
tar -czf "$BUNDLE_DIR.tar.gz" "$BUNDLE_DIR"
echo "Bundle created: $BUNDLE_DIR.tar.gz"

# Optional: Calculate checksum
sha256sum "$BUNDLE_DIR.tar.gz" > "$BUNDLE_DIR.tar.gz.sha256"
```

## Output
- `obsidian-debug-YYYYMMDD-HHMMSS.tar.gz` archive containing:
  - `summary.txt` - System and plugin info
  - `manifest.json` - Plugin manifest
  - `tsconfig.json` - TypeScript configuration
  - `console-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 |

## Examples

### Automated Debug Command
```typescript
// Add debug export command to plugin
this.addCommand({
  id: 'export-debug-data',
  name: 'Export Debug Data',
  callback: async () => {
    const debugData = {
      manifest: this.manifest,
      settings: this.sanitizeSettings(),
      obsidianVersion: this.app.version,
      plugins: Object.keys((this.app as any).plugins.plugins),
    };

    const blob = new Blob([JSON.stringify(debugData, null, 2)], {
      type: 'application/json'
    });
    const url = URL.createObjectURL(blob);

    const a = document.createElement('a');
    a.href = url;
    a.download = `${this.manifest.id}-debug.json`;
    a.click();

    URL.revokeObjectURL(url);
    new Notice('Debug data exported');
  },
});

private sanitizeSettings(): any {
  const settings = { ...this.settings };
  // Redact sensitive values
  for (const key of Object.keys(settings)) {
    if (key.toLowerCase().includes('key') ||
        key.toLowerCase().includes('token') ||
        key.toLowerCase().includes('secret')) {
      settings[key] = '[REDACTED]';
    }
  }
  return settings;
}
```

### Minimal Bug Report Template
```markdown
## Bug Report

**Plugin:** [Name] v[Version]
**Obsidian:** v[Version]
**OS:** [Windows/macOS/Linux]

### Steps to Reproduce
1.
2.
3.

### Expected Behavior
[What should happen]

### Actual Behavior
[What actually happens]

### Console Errors
```
[Paste errors here]
```

### Debug Bundle
[Attach obsidian-debug-*.tar.gz]
```

### Privacy Checklist Before Sharing
- [ ] API keys removed
- [ ] Personal paths sanitized
- [ ] Note content not included
- [ ] Vault name generic or removed
- [ ] No personal identifiers

## Resources
- [Obsidian Bug Reports](https://forum.obsidian.md/c/bug-reports/7)
- [Plugin Developer Help](https://forum.obsidian.md/c/developers/14)
- [Obsidian Discord #plugin-dev](https://discord.gg/obsidianmd)

## Next Steps
For rate limit issues, see `obsidian-rate-limits`.


---
Source attribution: Dicklesworthstone
Original project: https://github.com/Dicklesworthstone/pi_agent_rust/blob/f28fc46ee0db8e710d95b8b55592cd38d60f2b26/tests/ext_conformance/artifacts/plugins-community/plugins/saas-packs/obsidian-pack/skills/obsidian-debug-bundle/SKILL.md
License: MIT
License information: https://opensource.org/license/mit
Original upstream instructions; downloaded from Mega AI Hub.

## Upstream license notice

MIT License (with OpenAI/Anthropic Rider)

Copyright (c) 2026 Jeffrey Emanuel

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

ADDITIONAL RIDER / RESTRICTION (OpenAI / Anthropic):

This rider is part of the "conditions" of this License. In the event of any
conflict between this rider and any other portion of this License, this rider
controls.

"Restricted Parties" means OpenAI, L.L.C.; Anthropic, PBC; any of their
respective Affiliates; and any person or entity acting directly or indirectly
on behalf of, for the benefit of, or under the direction of any of the
foregoing (including any officer, director, employee, contractor, agent,
consultant, service provider, or representative).

Notwithstanding any other provision of this License, no rights are granted to
any Restricted Party. Any purported license, sublicense, assignment, transfer,
or other permission to any Restricted Party is null and void absent the
express prior written permission of Jeffrey Emanuel.

You may not provide, disclose, distribute, sublicense, sell, lease, lend,
host, make available, or otherwise permit access to the Software or any
derivative work of the Software (as defined in applicable copyright law)
(collectively, "Derivative Works") to or for any Restricted Party.

For purposes of this rider, "use" includes, without limitation: copying,
modifying, merging, publishing, distributing, sublicensing, selling,
transferring, making available, hosting, deploying, executing, benchmarking,
testing, analyzing, indexing, or incorporating the Software or any Derivative
Works into any dataset, training corpus, evaluation harness, or pipeline for
machine learning or other automated systems.

This rider applies to the Software and all Derivative Works. As a condition of
use, you agree that this rider is a precondition to exercising any rights
under this License, and you agree that any distribution of the Software or any
Derivative Works must include this rider provision unmodified.

Any breach of this rider automatically and immediately terminates the
permissions granted by this License. Upon termination, you must immediately
cease all use and distribution of the Software and any Derivative Works and
destroy all copies under your control.

You agree that a breach of this rider would cause irreparable harm and that
Jeffrey Emanuel may seek injunctive or other equitable relief to enforce this
rider, in addition to any other remedies available at law. To the maximum
extent permitted by applicable law, the prevailing party in any action to
enforce this rider shall be entitled to recover reasonable attorneys' fees and
costs.

For purposes of this rider, "Affiliate" means any entity that directly or
indirectly controls, is controlled by, or is under common control with the
specified party. "Control" means ownership of more than 50% of the voting
securities or other ownership interest, or the power to direct management or
policies by contract or otherwise.

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.



# Mega AI Hub resource metadata

Creator / publisher: Dicklesworthstone
Original project: https://github.com/Dicklesworthstone/pi_agent_rust/blob/f28fc46ee0db8e710d95b8b55592cd38d60f2b26/tests/ext_conformance/artifacts/plugins-community/plugins/saas-packs/obsidian-pack/skills/obsidian-debug-bundle/SKILL.md
Attribution basis: Source repository record

Fields of work: Sales, Customer Support
Roles: Customer Success Manager, Support Agent, Technical Support
Specialties: Specialty not specified
Tools: Obsidian
Country applicability: Country not specified
Classification basis: Source catalog labels
Instruction SHA-256: 8d52a24312b4c2e46c9df3900795a9d810b0cc91f3fdaa168107d37ccc020cd7