Halcyon 🔍

Halcyon is a Go-based CLI tool designed to identify and manage duplicate files in a directory, including nested subdirectories. With Halcyon, you can quickly detect duplicate files, view their paths, and take appropriate actions like moving, deleting, or listing them—all while ensuring a lightweight and fast execution.

---

Features 🌟

• Directory Traversal: Recursively scans directories, including nested subdirectories, for a comprehensive duplicate search.
• Duplicate Detection:
  • Identifies duplicate files by name and size.
  • Detects similar file names (e.g., file_copy, file (1)).
• Flexible Duplicate Management:
  • Move: Move duplicates to a specified folder.
  • Print: Display paths of duplicate files.
  • Delete: Permanently delete duplicates.
• User-Friendly CLI: Simple and intuitive command-line interface for easy operation.

---

Getting Started

Installation ⚙️

1. Clone this repository:

   git clone https://github.com/tejastn10/halcyon.git
   cd halcyon

2. Install dependencies:

   go mod tidy

3. Run the project:

   go run main.go

---

Usage

1. Build the project:

   go build -o halcyon

2. Run the CLI tool:

   You can pass the directory path as a flag (defaults to the current directory if no path is provided):

   ./halcyon --dir="/your/directory/path"

3. Available actions:

   After detecting duplicates, Halcyon will provide options:

   • Move duplicates to a folder.
   • Print duplicate file paths.
   • Delete duplicates.

---

Example Output

Total files: 2
Processed: 2
Skipped: 0
+-------+-----------------------+---------+---------------------+
| INDEX |         PATH          |  SIZE   |      MODIFIED       |
+-------+-----------------------+---------+---------------------+
|     0 | duplicates/file.txt   | 0.00 MB | 2024-12-31 22:21:48 |
|     1 | duplicates/file 1.txt | 0.00 MB | 2024-12-31 22:21:43 |
+-------+-----------------------+---------+---------------------+
Use the arrow keys to navigate: ↓ ↑ → ← 
? Choose action: 
  ▸ Keep all files
    Delete specific files
    Delete all duplicates
    Move files to backup
↓   Skip these duplicates

Project Structure 📂

halcyon/
├── cmd/                  # CLI commands
│   ├── root.go           # Main CLI entry point
├── tasks/                # Core logic for file operations
│   ├── traverse.go       # Directory traversal logic
├── utils/                # Utility functions
│   ├── utils.go          # Reusable helpers
├── go.mod                # Go module definition
├── go.sum                # Go module checksum
├── main.go               # Application entry point
├── README.md             # Project documentation
├── LICENSE.md            # Project license

Contributing 🤝

Contributions are welcome! Feel free to open an issue or submit a pull request if you have ideas to enhance Halcyon.

To-Do ✅

• Add support for advanced duplicate detection using file hashes.
• Allow configurable file actions via a config file.
• Improve performance for large directories.

---

License 📜

This project is licensed under the MIT License. See the LICENSE file for details.

---

Acknowledgments 🙌

• Named after Halcyon, symbolizing tranquility and clarity.
• Built with ❤️ and Go.