{"id":28629425,"url":"https://github.com/readium/cli","last_synced_at":"2026-07-10T01:00:35.740Z","repository":{"id":290335318,"uuid":"958680199","full_name":"readium/cli","owner":"readium","description":"⌨️ A CLI utility with support for a wide range of commands for ebooks, comics and audiobooks","archived":false,"fork":false,"pushed_at":"2026-06-06T08:43:54.000Z","size":293,"stargazers_count":23,"open_issues_count":13,"forks_count":8,"subscribers_count":8,"default_branch":"develop","last_synced_at":"2026-06-06T10:14:53.804Z","etag":null,"topics":["a11y","accessibility","audiobook","cli","epub","golang","readium"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/readium.png","metadata":{"files":{"readme":"README.MD","changelog":"CHANGELOG.MD","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-04-01T15:32:18.000Z","updated_at":"2026-06-06T09:15:34.000Z","dependencies_parsed_at":"2026-05-18T12:03:40.013Z","dependency_job_id":null,"html_url":"https://github.com/readium/cli","commit_stats":null,"previous_names":["readium/cli"],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/readium/cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readium%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readium%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readium%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readium%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/readium","download_url":"https://codeload.github.com/readium/cli/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readium%2Fcli/sbom","scorecard":{"id":334731,"data":{"date":"2025-08-18T02:45:27Z","repo":{"name":"github.com/readium/cli","commit":"49779d6ad4470f9295d96efa7a823b63842fb977"},"scorecard":{"version":"v5.2.1","commit":"ab2f6e92482462fe66246d9e32f642855a691dc1"},"score":6.4,"checks":[{"name":"Code-Review","score":1,"reason":"Found 3/18 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"30 commit(s) and 3 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#dangerous-workflow"}},{"name":"Dependency-Update-Tool","score":10,"reason":"update tool detected","details":["Info: detected update tool: Dependabot: .github/dependabot.yml:1"],"documentation":{"short":"Determines if the project uses a dependency update tool.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#dependency-update-tool"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql.yml:31","Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:32","Info: jobLevel 'contents' permission set to 'read': .github/workflows/scorecards.yml:29","Info: jobLevel 'actions' permission set to 'read': .github/workflows/scorecards.yml:30","Info: topLevel 'contents' permission set to 'read': .github/workflows/build.yml:10","Info: topLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:24","Info: topLevel 'contents' permission set to 'read': .github/workflows/depedency-review.yml:13","Warn: topLevel 'contents' permission set to 'write': .github/workflows/release.yml:9","Warn: topLevel 'packages' permission set to 'write': .github/workflows/release.yml:10","Info: topLevel permissions set to 'read-all': .github/workflows/scorecards.yml:18","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":9,"reason":"dependency not pinned by hash detected -- score normalized to 9","details":["Warn: containerImage not pinned by hash: Dockerfile:36","Info:  14 out of  14 GitHub-owned GitHubAction dependencies pinned","Info:   9 out of   9 third-party GitHubAction dependencies pinned","Info:   1 out of   2 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":10,"reason":"SAST tool is run on all commits","details":["Info: SAST configuration detected: CodeQL","Info: all commits (18) are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#sast"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":9,"reason":"1 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-q7pp-wcgr-pffx"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#vulnerabilities"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/release.yml:16"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#packaging"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v0.4.0 not signed: https://api.github.com/repos/readium/cli/releases/236419830","Warn: release artifact v0.3.0 not signed: https://api.github.com/repos/readium/cli/releases/232020880","Warn: release artifact v0.2.1 not signed: https://api.github.com/repos/readium/cli/releases/223886237","Warn: release artifact v0.2.0 not signed: https://api.github.com/repos/readium/cli/releases/219987543","Warn: release artifact v0.1.0 not signed: https://api.github.com/repos/readium/cli/releases/215901789","Warn: release artifact v0.4.0 does not have provenance: https://api.github.com/repos/readium/cli/releases/236419830","Warn: release artifact v0.3.0 does not have provenance: https://api.github.com/repos/readium/cli/releases/232020880","Warn: release artifact v0.2.1 does not have provenance: https://api.github.com/repos/readium/cli/releases/223886237","Warn: release artifact v0.2.0 does not have provenance: https://api.github.com/repos/readium/cli/releases/219987543","Warn: release artifact v0.1.0 does not have provenance: https://api.github.com/repos/readium/cli/releases/215901789"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#signed-releases"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: BSD 3-Clause \"New\" or \"Revised\" License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#license"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#security-policy"}},{"name":"Contributors","score":10,"reason":"project has 6 contributing companies or organizations","details":["Info: found contributions from: Feedbooks, comikey, edrlab, opds-community, readium, w3c"],"documentation":{"short":"Determines if the project has a set of contributors from multiple organizations (e.g., companies).","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#contributors"}},{"name":"CI-Tests","score":10,"reason":"18 out of 18 merged PRs checked by a CI test -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project runs tests before pull requests are merged.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#ci-tests"}}]},"last_synced_at":"2025-08-18T04:26:51.411Z","repository_id":290335318,"created_at":"2025-08-18T04:26:51.411Z","updated_at":"2025-08-18T04:26:51.411Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35316840,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-09T02:00:07.329Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["a11y","accessibility","audiobook","cli","epub","golang","readium"],"created_at":"2025-06-12T12:01:21.719Z","updated_at":"2026-07-10T01:00:35.734Z","avatar_url":"https://github.com/readium.png","language":"Go","funding_links":[],"categories":["Open-source applications"],"sub_categories":[],"readme":"# Readium Command Line Interface\n\nThe Readium CLI (Command Line Interface) is a multi-command utility based on the [`go-toolkit`](https://github.com/readium/go-toolkit).\n\nIt covers an extended set of use cases beyond reading, allowing authors, publishers, distributors, retailers and libraries to easily interact with publication files.\n\n## Installation\n\nMultiplatform builds are available directly from the [releases section](https://github.com/readium/cli/releases) of this repository.\n\nAs an alternative, to install `readium` in `~/go/bin`, run `make install`. Use `make build` to build the binary in the current directory.\n\n## List of commands\n\n| Command | Description |\n| ------- | ----------- |\n| [`manifest`](./docs/manifest.md) | The `manifest` command can parse a publication and return a [Readium Web Publication Manifest](https://readium.org/webpub-manifest/), which is printed to `stdout`. |\n| [`serve`](./docs/serve.md) | The `serve` command starts an HTTPS server that can serve publications. A log is printed to `stdout`. |\n\n## Potential additions\n\n| Command | Description | Discussion |\n| ------- | ----------- | ---------- |\n| `convert` | Convert back and forth between EPUB and Readium Web Publication. | |\n| `optimize` | Optimize images contained in an EPUB or a Readium Web Publication. | |\n| `package` | Package images or audio files into a Readium Web Publication. | \u003chttps://github.com/readium/cli/discussions/2\u003e |\n\n## Examples\n\n```sh\nreadium manifest --infer-a11y=split moby-dick.epub | jq .metadata\n```\n\n```json\n{\n  \"author\": {\n    \"name\": \"Herman Melville\",\n    \"sortAs\": \"MELVILLE, HERMAN\"\n  },\n  \"conformsTo\": \"https://readium.org/webpub-manifest/profiles/epub\",\n  \"contributor\": {\n    \"name\": \"Dave Cramer\",\n    \"role\": \"mrk\"\n  },\n  \"http://creativecommons.org/ns#attributionURL\": \"http://code.google.com/p/epub-samples/\",\n  \"http://purl.org/dc/terms/rights\": \"This work is shared with the public using the Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0) license.\",\n  \"http://www.idpf.org/2007/opf#version\": \"3.0\",\n  \"https://github.com/readium/go-toolkit#version\": \"v0.13.1\",\n  \"https://readium.org/webpub-manifest#inferredAccessibility\": {\n    \"accessMode\": [\n      \"visual\"\n    ],\n    \"feature\": [\n      \"tableOfContents\"\n    ]\n  },\n  \"identifier\": \"code.google.com.epub-samples.moby-dick-basic\",\n  \"language\": \"en-US\",\n  \"modified\": \"2012-01-18T12:47:00Z\",\n  \"layout\": \"reflowable\",\n  \"publisher\": \"Harper \u0026 Brothers, Publishers\",\n  \"title\": \"Moby-Dick\"\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freadium%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freadium%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freadium%2Fcli/lists"}