|
| 1 | + |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +## ✨ Features |
| 12 | + |
| 13 | +- 🗑 Move files and directories to a safe trash with history |
| 14 | +- ♻ Restore any previous version in seconds |
| 15 | +- 🕒 Built-in history tracking |
| 16 | +- 📦 Lightweight and fast |
| 17 | +- 💻 Works directly from the command line |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +## 🚀 Installation |
| 22 | + |
| 23 | +> ⚠ **.NET 9.0 SDK or newer is recommended** |
| 24 | +
|
| 25 | +```bash |
| 26 | +git clone https://github.com/UndefinedClear/Storm.git |
| 27 | +cd Storm |
| 28 | +dotnet build |
| 29 | +```` |
| 30 | + |
| 31 | +Or download the latest build from the **Releases** section. |
| 32 | + |
| 33 | +--- |
| 34 | + |
| 35 | +## 📖 Commands |
| 36 | + |
| 37 | +### 🆘 Help |
| 38 | + |
| 39 | +```bash |
| 40 | +storm |
| 41 | +``` |
| 42 | + |
| 43 | + |
| 44 | + |
| 45 | +--- |
| 46 | + |
| 47 | +### 🗑 Move to Trash |
| 48 | + |
| 49 | +Move one or multiple files and directories into Storm history. |
| 50 | + |
| 51 | +```bash |
| 52 | +storm test.txt |
| 53 | +storm folder1 folder2 image.png |
| 54 | +``` |
| 55 | + |
| 56 | + |
| 57 | + |
| 58 | +--- |
| 59 | + |
| 60 | +### ♻ Restore a Specific Version |
| 61 | + |
| 62 | +Restore a file or directory using its history ID or version. |
| 63 | + |
| 64 | +```bash |
| 65 | +storm -r HISTORY_ID_OR_VERSION test.txt |
| 66 | +storm -r 2026-01-29_21-03-03 folder1 |
| 67 | +``` |
| 68 | + |
| 69 | + |
| 70 | + |
| 71 | +--- |
| 72 | + |
| 73 | +### 🕒 View History |
| 74 | + |
| 75 | +Show all saved versions. |
| 76 | + |
| 77 | +```bash |
| 78 | +storm -h |
| 79 | +``` |
| 80 | + |
| 81 | + |
| 82 | + |
| 83 | +--- |
| 84 | + |
| 85 | +## 🧠 How It Works |
| 86 | + |
| 87 | +Storm keeps safe snapshots of deleted or replaced files so you can restore them later. |
| 88 | +Each operation is versioned with a timestamp, making recovery simple and reliable. |
| 89 | + |
| 90 | +--- |
| 91 | + |
| 92 | +## ⚙ Requirements |
| 93 | + |
| 94 | +* **.NET 9.0 SDK (recommended)** |
| 95 | +* Windows, Linux, or macOS |
| 96 | +* Terminal with ANSI color support |
| 97 | + |
| 98 | +--- |
| 99 | + |
| 100 | +## 📦 Releases |
| 101 | + |
| 102 | +Stable builds are available in the **Releases** section: |
| 103 | +➡ Download compiled binaries |
| 104 | +➡ View changelogs |
| 105 | +➡ Access previous versions |
| 106 | + |
| 107 | +--- |
| 108 | + |
| 109 | +## 🐞 Issues |
| 110 | + |
| 111 | +Found a bug or have a feature request? |
| 112 | +Open an issue here: |
| 113 | +👉 [https://github.com/UndefinedClear/Storm/issues](https://github.com/UndefinedClear/Storm/issues) |
| 114 | + |
| 115 | +Please include: |
| 116 | + |
| 117 | +* What happened |
| 118 | +* Steps to reproduce |
| 119 | +* Your OS and Storm version |
| 120 | + |
| 121 | +--- |
| 122 | + |
| 123 | +## 🤝 Contributing |
| 124 | + |
| 125 | +Pull Requests are welcome! |
| 126 | + |
| 127 | +1. Fork the repository |
| 128 | +2. Create a new branch |
| 129 | +3. Make your changes |
| 130 | +4. Submit a Pull Request |
| 131 | + |
| 132 | +Before submitting, please: |
| 133 | + |
| 134 | +* Follow the existing code style |
| 135 | +* Test your changes |
| 136 | + |
| 137 | +--- |
| 138 | + |
| 139 | +## 🔀 Pull Requests |
| 140 | + |
| 141 | +All improvements, fixes, and ideas are appreciated. |
| 142 | +Small PRs are reviewed faster 😉 |
| 143 | + |
| 144 | +--- |
| 145 | + |
| 146 | +## 🗺 Roadmap |
| 147 | + |
| 148 | +Planned improvements and upcoming features: |
| 149 | + |
| 150 | +* [ ] Auto-clean old history versions |
| 151 | +* [ ] Config file support (`storm.config`) |
| 152 | +* [ ] Ignore patterns (like `.gitignore`) |
| 153 | +* [ ] Restore preview before confirming |
| 154 | +* [ ] Compression for stored versions |
| 155 | +* [ ] Global install via `dotnet tool` |
| 156 | +* [ ] Interactive TUI mode |
| 157 | +* [ ] Performance improvements for large directories |
| 158 | + |
| 159 | +Have an idea? Open an issue and share it! |
| 160 | + |
| 161 | +--- |
| 162 | + |
| 163 | +## 📜 License |
| 164 | + |
| 165 | +This project is licensed under the MIT License. |
| 166 | + |
| 167 | +--- |
| 168 | + |
| 169 | +## ⭐ Support |
| 170 | + |
| 171 | +If Storm saved your files, give it a star ⭐ |
| 172 | +It helps the project grow! |
0 commit comments