librius 0.2.2

A personal library manager CLI written in Rust.
Documentation

📚 Librius

Build Status Docs.rs License: MIT Rust Edition

Librius — A fast, minimalist CLI to manage your personal book collection, built in Rust.

🧾 Overview

Librius is a cross-platform command-line tool written in Rust that helps you manage your personal library.
It uses a SQLite database to store your books and a simple YAML configuration file (librius.conf) for flexible setup.

This project aims to provide a clean, modular architecture with future extensions such as search, add/remove commands, and import/export support.

📦 Installation

🐧 AUR (Arch Linux)

AUR

yay -S librius
# or
paru -S librius

🍺 Homebrew (macOS/Linux)

Homebrew Version

brew tap umpire274/tap
brew install librius

🦀 Crates.io (Rust)

Crates.io

cargo install rtimelogger

⚙️ Features

Status Feature Description
✅ List Display all books stored in the local database
✅ Config management Manage YAML config via config --print, --init, --edit, and --editor
✅ Database migrations Automatic schema upgrades at startup
✅ Logging system Records operations and migrations in log table
✅ Verbose mode Optional --verbose flag for detailed debug output
✅ Database migrations Automatic schema updates at startup with detailed logging
✅ Safe patch system Each migration is idempotent and logged for traceability
🚧 Add / Remove Add or delete books via CLI commands
🚧 Search Search by title, author, or ISBN
🚧 Export / Import Export and import data (JSON, CSV)

🚀 Quick start

1️⃣ Clone the repository

git clone https://github.com/umpire274/librius.git
cd librius

2️⃣ Build and run

cargo build
cargo run -- list

If this is the first launch, Librius will automatically create:

  • The config file at ~/.config/librius/librius.toml
  • A SQLite database at ~/.config/librius/librius.sqlite

🧩 Example output

$ librius list

📚 Your Library

  1. The Hobbit (J.R.R. Tolkien) [1937]
  2. Foundation (Isaac Asimov) [1951]
  3. Dune (Frank Herbert) [1965]

⚙️ Configuration

# librius.conf
database: "C:/Users/YourName/AppData/Roaming/librius/librius.db"
language: "English"
  • Configuration file is automatically migrated if fields are missing or renamed.
  • Default path:
    • macOS/Linux → $HOME/.librius/librius.conf
    • Windows → %APPDATA%\Roaming\librius\librius.conf

📚 Documentation

The API and user-facing documentation for Librius is available on docs.rs:

To generate and view the documentation locally run:

cargo doc --no-deps --open

This will build the documentation and open it in your default browser.

🧰 Dependencies

clap — Command-line argument parsing rusqlite — SQLite database serde — Serialization/deserialization toml — Config format support colored — Colored terminal output

🗄️ Database management

Librius automatically verifies and upgrades the SQLite database schema at startup.

  • On first launch → creates books table.
  • On subsequent launches → runs pending migrations silently.
  • Migration results are recorded in the log table.

Each migration patch (PATCH_001, PATCH_002, …) is applied once and recorded in the internal log table. The process is fully idempotent — no duplicate operations are ever performed.

📘  Applying database patch: PATCH_002
✅  All pending migrations applied.
✅  Database schema is up-to-date.

Example table log

id date operation target message
1 2025-10-13T21:45:12+02:00 DB_CREATED DB Created new database
2 2025-10-13T21:45:13+02:00 DB_MIGRATION_OK DB Schema updated successfully

🔍 Verbose mode

Run Librius in diagnostic mode to display all internal initialization steps:

librius --verbose list

Output example:

📘  Loading configuration...
📘  Opening existing database at: C:\Users\A.Maestri\AppData\Roaming\librius\librius.db
✅ Database schema is up-to-date.
✅ Configuration verified.

📚 Your Library

In normal mode, only command output is displayed.

🧪 Development

Run in debug mode

cargo run -- list

Run with logging (future)

RUST_LOG=debug cargo run -- add "Neuromancer"

Format and lint

cargo fmt
cargo clippy

🧱 Future roadmap

  • Add add, remove, and search commands
  • Export/import JSON and CSV
  • Add optional TUI (Text UI) with ratatui
  • Multi-language support (English/Italian)
  • Web dashboard sync

🧑‍💻 Author

Umpire274 GitHub: @umpire274

📜 License

This project is licensed under the MIT License — see the LICENSE

⭐ Contribute

Contributions, feature requests, and ideas are welcome! If you’d like to contribute, please open a pull request or start a discussion.

🧡 Support

If you enjoy this project, please ⭐ star the repository — it helps visibility and development motivation!