# XivAr

[![crates.io](https://img.shields.io/crates/v/xivar.svg)](https://crates.io/crates/xivar)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/Mountlex/xivar/rust.yml?branch=main)
![actively developed](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg)
[![dependency status](https://deps.rs/crate/xivar/0.5.1/status.svg)](https://deps.rs/crate/xivar/0.5.1)
![License: MIT/Apache-2.0](https://img.shields.io/crates/l/xivar.svg)

Manage your local scientific library!

**This tool is still unstable. Your local database may be corrupt after updating!**

## Installation

Install `xivar` via

```bash
cargo install xivar
```

## Usage

`xivar` lets you search publications online at [DBLP](https://dblp.org/) and [arXiv](https://arxiv.org/), and open or download them if available. `xivar` saves the locations of downloaded publications and shows them in your next search.

### Search

Search a publication online and local.

```bash
xivar
```

### Clean

Clean your database, i.e. remove entries of publications which cannot be found at their saved location.

```bash
xivar clean
```

## Configuration

In Linux-based systems, the database is located at `~/.local/share/xivar`.
**Since this is still very much work in progress, the database may be corrupt after updating to a new version!**

You can configure the default download location via a configuration file located at `~/.config/xivar/xivar.toml` with the following content

```toml
document_dir = "absolute/path/to/directory"
```

## Roadmap

- Update library
- Specify query more precisely (title, author, AND, OR etc.)
- ...