oku

module
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 19, 2026 License: MIT

README

Oku

Contributors

Terminal companion for Hardcover: browse your shelves, search books, and track reading — all without leaving the terminal.

Oku demo flow

Features

  • Full TUI dashboard with vim-style navigation (h/j/k/l)
  • CLI for scripting and quick actions
  • Search by book, author, or genre
  • Reading streaks and stats tracking
  • Reading timer to log sessions
  • Local SQLite cache with auto-refresh

Install

macOS (Homebrew cask):

brew tap Kameleon21/oku
brew install --cask oku

Linux / Windows:

  • Download a prebuilt binary from GitHub Releases.
  • Or install from source with Go:
go install github.com/Kameleon21/oku/cmd/oku@latest

Development branch (latest features):

go install github.com/Kameleon21/oku/cmd/oku@develop

Getting Started

Oku connects to Hardcover, a book tracking platform. You'll need a free account and an API token.

  1. Create a free account at hardcover.app
  2. Go to Account Settings to find your API token
  3. Run the setup:
# Save your Hardcover API token
oku auth set-token

# Pull your library to local cache
oku sync

# Launch the TUI
oku

Your token is stored in the system keychain. You can also set HARDCOVER_TOKEN as an environment variable.

Usage

oku                    Launch TUI dashboard
oku tui                Launch TUI dashboard

oku search <query>     Search books (--mode book|author|genre)
oku now                Show current read
oku reading            Show reading list
oku update --page <N>  Update page progress

oku sync               Refresh all cached data
oku auth set-token     Set API token
oku config show        Show configuration

Use --json for JSON output and --view compact|default|verbose to control detail level.

TUI Navigation

Oku uses vim-style keybindings throughout. Arrow keys also work.

Key Action
h/l Move between panes
j/k Navigate lists
/ Search
Enter Select / toggle status
+/- Quick page update
? Help
q Quit

Config

Config lives at ~/.config/oku/config.toml:

editor = "nvim"
use_fzf = false
default_list = "reading"

Development

go test ./...
go build ./cmd/oku

Contributors

Contributors

Directories

Path Synopsis
cmd
oku command
internal
api
app
cli

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL