Archivus Core: Order from Chaos

Archivus is a declaration of war against digital entropy.

It's a professional-grade, command-line orchestrator for data hoarders, digital librarians, and self-hosting fanatics who believe in radical data sovereignty.

In an era of locked-down ecosystems and flimsy tools, archivus-core is the open-source engine for building your own perfect, autonomous media archive. It's not a simple renamer; it's a system designed for performance at terabyte-scale and absolute user control.

We provide the weapons:

• A Probabilistic Identify Engine: Thinks, doesn't just match. Analyzes filenames, metadata, and context to intelligently recognize your media with a transparent confidence score.
• The ASTDB (Abstract State Database): Your library's versioned, queryable ledger. Know what changed, when, and why. Roll back any operation with atomic precision.
• Rule-Based Sovereignty: Define your perfect structure in simple, human-readable KDL files. Your rules are law.
• Dry-Run-First & Snapshotting: Never lose a byte. Preview every move. Git-like immutable snapshots guard your entire collection.
• Offline-First & Telemetry-Free: Zero cloud dependencies. Zero phone homes. Your data never leaves your fortress.

This is the engine that will power the next generation of self-hosted media empires. The code is yours. The control is yours. The chaos is the enemy.

Join the fight.

---

Quick Start

1. Install: [Installation instructions for your platform]
2. Configure: Define your world order in archivus.kdl:

   structure {
       movies "{title} ({year})/{title} ({year}).{ext}" mode="flat"
       series "{series}/Season {season}/{series} S{season}E{episode}.{ext}" mode="hierarchical"
       music "{artist}/{album}/{track:02d} - {title}.{ext}" mode="flat"
   }
   

3. Conquer:

   # Scan your chaos
   archivus scan /mnt/chaos --ext=mkv,mp4,mp3 --out=alt.astdb.json
   
   # Plan the new order
   archivus structure alt.astdb.json archivus.kdl /mnt/library --dry-run
   
   # Enforce it
   archivus enforce alt.astdb.json neu.astdb.json
   
   # Create a snapshot of your new empire
   archivus snapshot neu.astdb.json state_$(date +%Y-%m-%d).sbom.json
   

Philosophy

Archivus Core is built on three uncompromising principles:

1. User Souveränity: You are the absolute authority. The tool is an instrument of your will.
2. Performance at Scale: Built in Nim for raw speed and minimal overhead, from a few files to 300TB collections.
3. Resilience and Auditability: Every action is logged, versioned, and reversible. No black boxes.

License

Archivus Core is licensed under the EUPL-1.2. It is Free and Open Source software, designed to remain so forever. See LICENSE for details.

The Archivus Ecosystem

• archivus-core (This repo): The sovereign, open-source engine.
• Archivus Services (Commercial): Enterprise-grade add-ons offering automated scheduling, cloud backups, a web UI, and metadata enrichment, all built on top of this core API.

Contributing

We welcome those who wish to forge better tools. Please read CONTRIBUTING.md for guidelines on how to join the development of this core engine.