GoRead

GoRead is a terminal/CLI EPUB reader written in Golang, inspired by epr.

中文文档

Features

• Remembers last read file (just run goread without arguments)
• Remembers last read state for each file (state saved in $HOME/.config/goread/config or $HOME/.goread)
• Code highlighting
• Adjustable text area width
• Adapts to terminal size changes
• EPUB3 support (without audio)
• Vim-style key bindings
• Image viewing support (using system default image viewer)
• Dark/light color schemes (depending on terminal color capabilities)
• Cross-platform

Roadmap

• Support for mobi format

Usage

goread             Read the last opened epub
goread EPUBFILE    Read specified EPUBFILE
goread STRINGS     Read file matching STRINGS from history
goread NUMBER      Read file numbered NUMBER from history

Options

-r              Print reading history
-d              Export epub content
-h, --help      Print help information

Key Bindings

Help             : ?
Quit             : q
Table of Contents: t
Next Chapter     : n
Previous Chapter : N
Search           : /
Scroll Down      : j
Scroll Up        : k
Half Page Up     : C-u
Half Page Down   : C-d
Chapter Start    : g
Chapter End      : G
Open Image       : o
Increase Width   : +
Decrease Width   : -
Metadata         : m
Toggle Color     : c

Installation

Install the latest release binary to your user directory:

Linux / macOS (~/.local/bin):

curl -fsSL https://raw.githubusercontent.com/Ray-D-Song/goread/main/scripts/install.sh | bash

Windows (%LOCALAPPDATA%\goread\bin):

irm https://raw.githubusercontent.com/Ray-D-Song/goread/main/scripts/install.ps1 | iex

You can customize the install location with INSTALL_DIR:

INSTALL_DIR="$HOME/bin" curl -fsSL https://raw.githubusercontent.com/Ray-D-Song/goread/main/scripts/install.sh | bash

$env:INSTALL_DIR = "$env:USERPROFILE\bin"; irm https://raw.githubusercontent.com/Ray-D-Song/goread/main/scripts/install.ps1 | iex

Scripts are also available in scripts/.

Dependencies

• Go 1.16 or higher
• tcell - Terminal handling library
• tview - Terminal UI library

Building

See Makefile for details

# Build for current platform
make build

# Build for specific platforms
make windows
make linux
make macos

# Build for all platforms
make all

# Clean build artifacts
make clean

License

MIT