librius 0.1.0

A personal library manager CLI written in Rust.
Documentation

📚 Librius

Build Status Crates.io 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 TOML configuration file 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.

⚙️ Features

Status Feature Description
✅ List Display all books stored in the local database
✅ Config auto-init Creates default librius.toml config file in ~/.config/librius/
🚧 Add / Remove Add or delete books via CLI commands
🚧 Search Search by title, author, or ISBN
🚧 Export / Import Export and import data (JSON, CSV)

🏗️ Architecture

ibrius/
├── Cargo.toml
├── src/
│ ├── main.rs # CLI entry point
│ ├── config.rs # Configuration management
│ ├── db.rs # SQLite initialization
│ ├── models.rs # Data models (Book, etc.)
│ └── commands/
│ └── list.rs # 'list' command logic
├── config/
│ └── librius.toml # Default config file
└── README.md

🚀 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.db

🧩 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

The default configuration file is stored at:

Linux/macOS: ~/.config/librius/librius.toml

Windows: %APPDATA%\librius\librius.toml

Example:

db_path = "/home/alessandro/.config/librius/librius.db"

📚 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

🧪 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!