summaryrefslogtreecommitdiff
path: root/README.md
blob: 291a913284441bf56cdbd39402ed1eca9c98f240 (plain)
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
# myal - My Anime Library

## Overview

My Anime Library is a CLI-Tool to manage an anime and manga list.  
I used to track which anime I have watched and what episode I'm on by writing in
a text file, which got annoying after a while.  
This is why I created this tool to keep anime and manga organized in a sqlite3
database.  

## Quickstart

You need a database with tables `anime` and `manga`. Attached in this repo
is a setup script for the database. Simply execute
```
sqlite3 library.db <db-setup.sql
```

This will create the following tables:  
anime(ID integer pk, NAME text, EPISODE text, STATUS text)  
manga(ID integer pk, NAME text, CHAPTER text, STATUS text)  

Chapters and episodes are stored as text, because sometimes the chapter isn't
just a number but rather in the form "Volume 6 Chapter 4", shortened to "V6CH4".
When I'm done with an anime or manga, I set the episode or chapter to 0 and set
the status to "done".  

The database file is expected to be in "~/.local/share/sqlite/library.db".  
To compile, do
```bash
make
```

&nbsp;

To install it in /usr/local/bin/, do
```bash
sudo make install
```

## Usage

Currently there are 3 modes:
- get, which retrieves one or more anime or manga by the given name argument
- set, which updates the episode or chapter and/or the status of a given entry
- add, which adds a new entry to a given table

Here are examples for each mode:

```
myal get anime jojo
```

```
myal set manga "Nikubami Honegishimi" 3
myal set anime "Lucky Star" done
myal set anime "Durarara!!" 13 "watching"
```

```
myal add anime "Detective Conan" 1 "not started"
```