🔖TAGanrog

A personal tagging system and a search engine for your media library.

Table Of Contents

• About the Project
• Demo
• Features
• Built With
• Installation
• Usage
  • CLI
  • Web UI
• License

About the Project

In the digital age, where the quantity of files and data we handle is enormous, finding the exact file you need can be like looking for a needle in a haystack. Taganrog is designed to solve this problem by allowing you to tag your files with custom tags and then search through them as easily as you would search the web using Google. Whether it's documents, images, videos, or any other file type, Taganrog brings order to chaos, making your digital life more organized and efficient.

Demo

Features

• ✨ Google-like web UI: Search your files in a neat, Google-like search bar.
• ⚡ Blazingly Fast: tags autocompletion, searching media files, adding/removing tags, everything works within milliseconds(!)
• 💾 Local Storage: All your tags and files are stored locally on your machine. There is NO server.
• 🖥️ CLI: Taganrog is also a CLI tool that allows you to manage your tags and files from the command line.
• 📦 Portable: Taganrog is a single binary (that includes both - the CLI and the Web UI), that you can run on any platform without any dependencies.
• 📤 Exportable: The entire DB is just a single JSON file that is human-readable and can be easily exported to other systems.

Built With

This project was built using the following open-source frameworks/libraries:

• for Web UI: Axum + Askama + HTMX
• for CLI: Clap
• for DB: append-only JSON file (using serde)

Installation

There are four ways to install Taganrog:

1. Using the pre-built binaries:

   • Download the latest binary from the releases page and run it.

2. Using Cargo:

   • If you have Rust installed, you can install Taganrog using Cargo:

   cargo install taganrog
   

3. Using Docker:

   • You can also run Taganrog using Docker:

   docker run -p 1698:1698 -v /path/to/some/directory:/workdir darkcodi/taganrog
   

   • Replace /path/to/some/directory with the path to your media files
   • The web UI will be available at http://localhost:1698

4. Building from source:

   • Clone the repo and build the project using Cargo:

   git clone https://github.com/darkcodi/taganrog.git
   cd taganrog
   cargo build --release
   

   • The binary will be available at target/release/taganrog
   • [Linux only] You can also install the binary to your system using:

   sudo cp target/release/taganrog /usr/local/bin
   

   • [Windows only] You can also install the binary to your system by adding the target\release directory to your PATH.

Usage

CLI

Taganrog can be used as a CLI tool to manage your tags and files. Here are some of the available commands:

• taganrog tag <file> <tag1> [tag2 ...]: Tag a file with one or more tags.
• taganrog untag <file> <tag1> [tag2 ...]: Remove one or more tags from a file.
• taganrog list [tag]: List all tags that start with a specific prefix. If no prefix is provided, all tags are listed.
• taganrog search <tag1> [tag2 ...]: Search for files with a specific tag or tags.

Web UI

Taganrog also provides a web UI that can be accessed by visiting http://localhost:1698 in your browser. The web UI allows you to search for files using tags and manage your tags.

• Search: Enter tags in the search bar to search for files that have those tags.
• Add/Delete Tags: Click on some media file and then add/remove tags to it on the right-side panel.
• Upload Files: Click on the Upload button in the top right corner and select a file(s) to upload.
• Delete Files: Open a media by clicking it and press the Delete button on the right-side pane to delete it.
• Tags Cloud: Click on the Cloud button in the top right corner to see a cloud of your top 100 used tags.

License

Distributed under the MIT License. See LICENSE for more information.