🏦 AutoVault

Automated Obsidian vault structure manager for customer-centric operations (RUN/SOC workflows).

AutoVault creates and maintains a standardized folder structure in your Obsidian vault, complete with templates and plugin configuration.

---

📦 Installation

Quick Install (recommended)

# Install to ~/.local (no sudo required)
curl -fsSL https://raw.githubusercontent.com/Spifuth/AutoVault/main/install.sh | bash -s -- --user

# Or system-wide installation
curl -fsSL https://raw.githubusercontent.com/Spifuth/AutoVault/main/install.sh | bash

Homebrew (macOS/Linux)

brew tap Spifuth/autovault
brew install autovault

Arch Linux (AUR)

yay -S autovault

Manual Installation

git clone https://github.com/Spifuth/AutoVault.git
cd AutoVault
sudo ./install.sh

---

⚡ Quick Start

# 1. Initialize a new vault (interactive)
autovault init --profile pentest

# 2. Add your first customer
autovault customer add 1 --name "Acme Corp"

# 3. Check your setup
autovault doctor

# 4. (Optional) Create a short alias
autovault alias install av

That's it! Your vault is ready with:

• 📁 Folder structure for all customers
• 📝 Templates applied to all index files
• ⚙️ Obsidian plugins configured (Templater, Dataview)
• 📊 Dynamic Run-Hub dashboard

Note: Use autovault init --list-profiles to see available profiles (minimal, pentest, audit, bugbounty).

---

📖 Documentation

Document	Description
docs/COMMANDS.md	Complete CLI reference
docs/CONFIGURATION.md	Configuration options
docs/TEMPLATES.md	Template system guide
docs/OBSIDIAN-SETUP.md	Obsidian plugin setup

---

🗂️ What It Creates

YourVault/
├── Run-Hub.md                    # Dashboard with Dataview queries
├── Run/
│   ├── CUST-002/
│   │   ├── CUST-002-Index.md     # Customer hub
│   │   ├── CUST-002-FP/          # First Pass (routine checks)
│   │   ├── CUST-002-RAISED/      # Incidents/tickets
│   │   ├── CUST-002-INFORMATIONS/# Knowledge base
│   │   └── CUST-002-DIVERS/      # Misc/sandbox
│   ├── CUST-004/
│   └── ...
└── _templates/
    └── Run/                      # Auto-applied templates

---

🔧 Requirements

• Bash 4+ (Linux, macOS, WSL)
• jq - JSON processor
• Python 3 - For JSON/template operations
• rsync + ssh - For remote sync feature (optional)

# Check requirements
./cust-run-config.sh requirements check

# Auto-install (Debian/Ubuntu)
./cust-run-config.sh requirements install

---

🎯 Core Commands

# Configuration
autovault config       # Interactive setup wizard
autovault status       # Show current status
autovault doctor       # Run diagnostics

# Vault Management (recommended)
autovault vault init   # Full setup: structure + templates + plugins

# Customer Management
autovault customer add <id>       # Add customer
autovault customer remove <id>    # Remove customer
autovault customer list           # List all customers

# Backup & Restore
autovault backup create           # Create backup
autovault backup restore <name>   # Restore backup

# Export & Reports
autovault export pdf <target>     # Export to PDF
autovault export html <target>    # Export to HTML
autovault export report <id>      # Generate client report

# Tool Integrations
autovault git-sync watch          # Auto-sync vault changes
autovault nmap import <file> -c <id>   # Import Nmap scans
autovault burp import <file> -c <id>   # Import Burp findings

# System Integration
autovault alias install av        # Create 'av' command
autovault completions install     # Enable tab-completion

See docs/COMMANDS.md for the complete reference.

---

🔌 Obsidian Plugins

AutoVault auto-configures these plugins:

Plugin	Purpose
Templater	Auto-apply templates when creating notes in CUST folders
Dataview	Dynamic queries in Run-Hub (open incidents, stats)

Install them from Obsidian: Settings → Community Plugins → Browse

---

�️ Integrations

Integration	Description
Git Auto-Sync	Automatic commit/push on vault changes
Nmap	Import scan results into customer folders
Burp Suite	Import vulnerability findings with severity
Remote Sync	Push/pull vault via SSH/rsync
Export	PDF, HTML, Markdown export with templates

---

�📁 Project Structure

AutoVault/
├── cust-run-config.sh          # Main CLI entry point
├── config/
│   ├── cust-run-config.json    # Your vault configuration
│   ├── templates.json          # All templates in JSON
│   └── obsidian-settings.json  # Plugin settings to apply
├── bash/
│   ├── lib/
│   │   ├── config.sh           # Config management
│   │   └── logging.sh          # Logging utilities
│   ├── New-CustRunStructure.sh
│   ├── Manage-Templates.sh
│   ├── Configure-ObsidianPlugins.sh
│   └── ...
├── docs/                       # Documentation
└── tests/                      # Automated tests

---

🧪 Testing

# Run all tests
./tests/run-tests.sh

# Test specific functionality
./cust-run-config.sh test       # Verify vault structure
./cust-run-config.sh validate   # Validate configuration

---

📜 License

MIT License - See LICENSE for details.

---

🤝 Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing)
3. Commit your changes
4. Push and open a Pull Request

---

Made with ❤️ for SOC/RUN teams who love organized documentation.