cli

module
v0.3.0 Latest Latest
Warning

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

Go to latest
Published: Jul 13, 2025 License: BSD-3-Clause

README

Readium Command Line Interface

The Readium CLI (Command Line Interface) is a multi-command utility based on the go-toolkit.

It covers an extended set of use cases beyond reading, allowing authors, publishers, distributors, retailers and libraries to easily interact with publication files.

Installation

Multiplatform builds are available directly from the releases section of this repository.

As an alternative, to install readium in ~/go/bin, run make install. Use make build to build the binary in the current directory.

List of commands

Command Description
manifest The manifest command can parse a publication and return a Readium Web Publication Manifest, which is printed to stdout.
serve The serve command starts an HTTPS server that can serve publications. A log is printed to stdout.

Potential additions

Command Description Discussion
convert Convert back and forth between EPUB and Readium Web Publication.
optimize Optimize images contained in an EPUB or a Readium Web Publication.
package Package images or audio files into a Readium Web Publication. https://github.com/readium/cli/discussions/2

Directories

Path Synopsis
internal
cli
pkg
serve/client
* Written in 2019 by Andrew Ayer * * To the extent possible under law, the author(s) have dedicated all * copyright and related and neighboring rights to this software to the * public domain worldwide.
* Written in 2019 by Andrew Ayer * * To the extent possible under law, the author(s) have dedicated all * copyright and related and neighboring rights to this software to the * public domain worldwide.

Jump to

Keyboard shortcuts

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