🗑️ Vanish (vx)

A modern, safe file deletion tool with recovery capabilities

Features • Installation • Quick Start • Themes • Documentation

---

🎥 See It In Action

---

🌟 Why Vanish?

Accidentally deleted an important file? Vanish gives you peace of mind with a smart cache system that lets you recover files easily. Say goodbye to permanent deletion anxiety and hello to confident file management.

✨ Features

🛡️ Safe Deletion Files move to cache, never truly deleted 🔄 Pattern-based Recovery Restore using wildcards and flexible matching 📊 Rich Statistics Track cache usage and file metrics 🎨 Beautiful TUI 8 stunning built-in themes

⚡ Blazing Fast Handles large directories effortlessly 🔧 Highly Configurable Customize via simple TOML config 📝 Audit Trails Complete operation logging 🧹 Auto Cleanup Configurable retention policies

---

🚀 Installation

Quick Install (Recommended)

Using curl:

curl -LsSf https://raw.githubusercontent.com/Nurysso/vanish/main/install.sh | sh

Using wget:

wget -qO- https://raw.githubusercontent.com/Nurysso/vanish/main/install.sh | sh

Install Specific Version

Replace <tag> with your desired version (e.g., v0.9.0):

curl -LsSf https://raw.githubusercontent.com/Nurysso/vanish/<tag>/install.sh | sh

Build from Source

git clone https://github.com/Nurysso/vanish.git
cd vanish && make build
sudo mv vx /usr/local/bin/

---

📖 Quick Start

Basic Operations

# Delete files/directories safely
vx file.txt folder/ *.log

# List everything in cache
vx --list

# Restore files by pattern
vx --restore "*.txt" "project-*"

# Get detailed file info
vx --info "important-file"

# Clear entire cache
vx --clear

# Remove files older than 30 days
vx --purge 30

# View cache statistics
vx --stats

# Skip confirmations (use with caution!)
vx --restore --noconfirm "*.backup"

---

🎨 Themes & Customization

Vanish includes 8 gorgeous themes designed for different moods and environments:

Default 🎯 Clean & Professional	Dark 🌑 High Contrast	Light ☀️ Bright & Minimal	Cyberpunk 🌆 Neon Futuristic
Minimal ✨ Distraction-Free	Ocean 🌊 Calming Blues	Forest 🌲 Natural Greens	Sunset 🌅 Warm & Cozy

Try Them Out

# Interactive theme selector
vx --themes

Customize further via the configuration file.

---

📋 Command Reference

Command	Shorthand	Description
vx <files...>	—	Move files/directories to cache
--restore <pattern>	-r	Restore files matching pattern
--list	-l	Show all cached files
--info <pattern>	-i	Detailed info about items
--clear	-c	Empty entire cache
--purge <days>	-pr	Remove files older than N days
--stats	-s	Display cache statistics
--path	-p	Show cache directory location
--themes	-t	Interactive theme browser
--config-path	-cp	Show config file location
--noconfirm	-f	Skip all confirmation prompts
--help	-h	Show help information
--version	-v	Display version

---

🎯 Pattern Matching Examples

Vanish supports powerful glob patterns for precise file restoration:

# Exact match
vx --restore "document.pdf"

# All text files
vx --restore "*.txt"

# Files starting with 'backup'
vx --restore "backup-*"

# Multiple patterns at once
vx --restore "*.log" "config.*" "test-*"

# Year-based restoration
vx --restore "*-2024-*"

---

🛡️ Safety Features

✅ Atomic Operations Prevents data corruption during moves ✅ Path Validation Comprehensive conflict prevention ✅ Collision Detection Smart naming conflict resolution

✅ Permission Preservation Maintains original file attributes ✅ Transaction Logging Complete audit trail ✅ Integrity Checks Verification during restoration

---

⚙️ Configuration

Vanish uses TOML for easy, human-readable configuration. Customize cache location, retention policies, themes, and more.

📚 View Full Configuration Guide →

# Show config file location
vx --config-path

---

⚠️ Important Notes

Cache Directory Warning

Never manually modify the cache directory structure. To change the cache location:

1. Update the configuration file
2. Run vx --clear to empty the old location
3. Restart using the new location

Security Considerations

• Original file permissions are preserved
• Respects filesystem ACLs and extended attributes
• Symbolic links preserved but not followed
• Hidden files require explicit specification

---

🤝 Contributing

We welcome contributions of all kinds! Here's how to get started:

1. Fork the repository
2. Create your feature branch: git checkout -b feature/AmazingFeature
3. Lint your code: make lint
4. Commit your changes: git commit -m 'Add AmazingFeature'
5. Push to the branch: git push origin feature/AmazingFeature
6. Open a Pull Request

Report Bugs or Request Features

• 🐛 Report a Bug
• 💡 Request a Feature

---

LICENSE.

---

Acknowledgments

Built with using:

• Bubble Tea - Powerful TUI framework
• Lip Gloss - Beautiful terminal styling

---

🔗 Links

Homepage • Documentation • Releases • Discussions

---

Made with ❤️ by Nurysso

⭐ Star this repo if Vanish made your life easier!