aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 1f59fecd754332b5d139a637b4368f2e6cdc71aa (plain) (blame)
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
# 📺 Tama

<a href="https://anilist.co/character/161223" target="_blank"><img src="https://i.imgur.com/rxqMH46.png" align="right" height="420vw"></a>

A command-line client for navigating and streaming anime from [Hiruki](https://hiruki.xyz)

Tama allows you to view recent anime trends, search for any anime, and watch any
anime directly on your local system in a trivial manner.

Tama supports any video player and defaults to [`mpv`](https://mpv.io/), but
optionally allows you to open and view anime in your browser instead of a local
video player.

## Usage

You can download the script and run it locally, but I'd recommend fetching and
running it from GitHub to ensure that you are always on the latest version:

```shell
bash <(curl -s "https://raw.githubusercontent.com/Fuwn/tama/main/tama")
```

> Hint: Alias this in your shell profile: `alias tama="bash <(curl -s "https://raw.githubusercontent.com/Fuwn/tama/main/tama")"`

### Watch Flow

```shell
# Find an anime to watch
tama s my dress-up darling

# Watch episode 1 using the ID found from the previous search operation
tama w 132405 1
```

### `--help`

```text
tama - Command-line Hiruki Client

Usage:
  tama COMMAND
  tama [COMMAND] --help | -h
  tama --version | -v

Commands:
  trending    Trending anime
  popular     Popular anime
  upcoming    Upcoming anime
  current     Currently airing anime
  search      Search for a number of anime
  watch       Watch an anime by episode
  episodes    An anime's episodes
  recommend   View recommended and similar anime
```

### Dependencies

- [curl](https://curl.se/)
- [jq](https://jqlang.github.io/jq/)
- [mdcat](https://github.com/swsnr/mdcat)

## Licence

This project is licensed with the [GNU General Public License v3.0](LICENSE).