Bangumi Terminal UI

Bangumi CLI and TUI in Golang

Bangumi.tv is a database where users can save and manage their watched status and episode progress for TV shows, anime, and games. With bangumi-cli, users can easily interact with the website on their terminals.

It is under active development and features will change. Feel free to submit an issue if you find one.

Commands

• ui or empty Start terminal UI
• auth Auth commands
• completion Generate the autocompletion script for the specified shell
• help Help about any command
• list List collection
• sub Subject/Collection actions
• version Print the version number of bgm-cli
• cal Show calendar (airing animes)

Screenshots

Calendar

Subject

Collection

Edit collection

Search

Development

Build

go build -o dist/bgm

Lint

gofumpt -w .
golangci-lint run

Or make

CLI

go run . help

UI

go run . ui

Download

1. Download the binary for your platform from the Releases page.

2. Make the binary executable (if required) and rename it to bgm:

   chmod +x bgm-<platform>-<arch>
   mv bgm-<platform>-<arch> bgm

3. Move it to a directory in your PATH (e.g., ~/.local/bin/) to make it easier to use:

   mv bgm ~/.local/bin/

4. Run the binary:

   bgm

For Windows, double-click the .exe file or run it from the command prompt.

Note

You will probably be prompted with security warning by the system. It is because bgm is not signed. You can either trust the binary, or install from source using Go.

Tip

If you are not sure about CJK font and have not configured your terminal for Chinese. It is recommended to use Maple Mono for better displaying of Chinese and Japanese.

Installation with Go

If you have Go installed, you can install the binary directly using the following command:

go install github.com/iucario/bangumi-go@latest
cd ~/go/bin
mv bangumi-go bgm

This will install the bgm binary in your $GOPATH/bin or $HOME/go/bin directory. Make sure this directory is in your system's PATH to use the bgm command globally.