xivar 0.3.2

Manage your local scientific library
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

# XivAr

[![crates.io](https://img.shields.io/crates/v/xivar.svg)](https://crates.io/crates/xivar)
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Mountlex/xivar/Rust)
![actively developed](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg)
[![dependency status](https://deps.rs/crate/xivar/0.4.0/status.svg)](https://deps.rs/crate/xivar/0.3.1)
![License: MIT/Apache-2.0](https://img.shields.io/crates/l/xivar.svg)

Manage your local scientific library!

**This tool is in a very early development stage.**

## Installation

First, install [fzf](https://github.com/junegunn/fzf). **_(required)_**

Then 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 search keyword1 keyword2 ...
```

Search only locally saved files.

```bash
xivar local keyword1 keyword2 ...
```

### Clean

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

```bash
xivar clean
```

### Add

Add a local pdf to the database.

```bash
xivar add paper.pdf
```

If `xivar` finds any metadata in the PDF-file, you can confirm to search the title online. If you can find the matching paper online, all necessary information will be fetched and written to your library. Otherwise, you have to manually enter them.

## 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
- Export bib-files
- Specify query more precisely (title, author, AND, OR etc.)
- ...