An open API service indexing awesome lists of open source software.

https://github.com/alvarorichard/goanime

A TUI tool to browse, stream, and download anime in PT-BR and EN
https://github.com/alvarorichard/goanime

ani-cli ani-cli-br anime anime-download anime-downloader anime-search brazilian-portuguese cli downloader english english-language go goanime golang linux mac portuguese pt-br tui windows

Last synced: about 2 months ago
JSON representation

A TUI tool to browse, stream, and download anime in PT-BR and EN

Awesome Lists containing this project

README

          



English |
Рortuguês


GoAnime Logo


GitHub license
GitHub stars
GitHub last commit
GitHub forks
Build Status
GitHub contributors
Discord

# GoAnime

GoAnime is a simple text-based user interface (TUI) built in Go, allowing users
to search for anime and either play or download episodes directly in mpv. It
scrapes data from websites to provide a selection of anime and episodes, with
support for both subbed and dubbed content in English and Portuguese.

## Table of contents

1. [Features](#features)
2. [Prerequisites](#prerequisites)
3. [Installation](#installation)
4. [How to use](#how-to-use)
5. [Advanced usage](#advanced-usage)
6. [Community and mobile](#community-and-mobile)
7. [Contributing](#contributing)

## Features

* Search for anime, movies, and TV shows by name
* Simultaneous multi-source searching by default across all active platforms
* Support for subbed and dubbed content in English and Portuguese
* Play online with quality selection or download episodes
* Discord RPC integration to show what you're watching
* Progress tracking: Resume playback and track watched episodes

* Built-in upscaling (Anime4K) for better video quality

## Prerequisites

Before installing GoAnime, ensure you have the following dependency installed:
* [mpv](https://mpv.io/) (Media player, latest version recommended)

## Installation

Choose the installation method that best fits your system.

### Universal installation

If you have Go installed on your system, you can install GoAnime via `go install`:

```bash
go install github.com/alvarorichard/Goanime/cmd/goanime@latest
```

### macOS

Install `mpv` using Homebrew, then download and configure GoAnime:

```bash
brew install mpv

curl -Lo goanime https://github.com/alvarorichard/GoAnime/releases/latest/download/goanime-apple-darwin
chmod +x goanime
sudo mv goanime /usr/local/bin/

sudo xattr -d com.apple.quarantine /usr/local/bin/goanime
```

### Linux

Debian / Ubuntu (and derivatives)

```bash
sudo apt update
sudo apt install mpv -y

curl -Lo goanime https://github.com/alvarorichard/GoAnime/releases/latest/download/goanime-linux
chmod +x goanime
sudo mv goanime /usr/local/bin/
```

Arch Linux / Manjaro (AUR)

```bash
yay -S goanime
```

Fedora

```bash
sudo dnf update
sudo dnf install mpv

curl -Lo goanime https://github.com/alvarorichard/GoAnime/releases/latest/download/goanime-linux
chmod +x goanime
sudo mv goanime /usr/local/bin/
```

### Windows

**Strongly Recommended:** Use our installer for the best experience.

1. Download and run the [GoAnime Windows Installer](https://github.com/alvarorichard/GoAnime/releases/latest/download/GoAnimeInstaller.exe).
2. Install `mpv` for Windows and ensure it is available in your system's path.

## How to use

Follow these steps for a simple, interactive watching experience:

1. **Open your terminal.**
2. **Start the app:** Type `goanime` and press `Enter`.
3. **Search:** Provide the name of the anime you want to watch.
4. **Select:** Navigate the resulting list using your arrow keys and press
`Enter` to pick an anime.
5. **Watch:** Select an episode, choose your preferred streaming quality, and
the video will automatically launch in `mpv`.

## Advanced usage

### Direct search

To bypass the initial prompt, directly pass the anime name:

```bash
goanime "Naruto"
```

### Updating the app

Keep GoAnime updated to the newest features without manual downloads:

```bash
goanime --update
```

### Help

To view all available commands and flags:

```bash
goanime -h
```

## Community and mobile

Join our Discord for support, feedback, and updates:
[Join the Discord server](https://discord.gg/6nZ2SYv3)

A mobile version of GoAnime is also available for Android devices:
[GoAnime Mobile](https://github.com/alvarorichard/goanime-mobile)

## Contributing

Contributions to improve or enhance are always welcome.

See the [development guide](docs/Development.md).

Quick start:
1. Fork the project and read the development guide.
2. Create your feature branch from `dev` (`git checkout -b feature/foo`).
3. Follow formatting standards (`go fmt`).
4. Commit your changes (`git commit -m 'feat: add foo'`).
5. Push to the branch (`git push origin feature/foo`).
6. Open a pull request to the `dev` branch.

All changes must go through the `dev` branch first.