{"id":19942656,"url":"https://github.com/erueri/oyomu","last_synced_at":"2025-06-11T03:36:31.884Z","repository":{"id":180935705,"uuid":"665942856","full_name":"EruEri/oyomu","owner":"EruEri","description":"A command line comic reader and collection manager","archived":false,"fork":false,"pushed_at":"2025-06-08T23:05:23.000Z","size":21,"stargazers_count":14,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-09T00:18:56.057Z","etag":null,"topics":["cli","comics-collection","comics-reader","epub-reader","ocaml","terminal"],"latest_commit_sha":null,"homepage":"https://codeberg.org/EruEri/oyomu","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EruEri.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}},"created_at":"2023-07-13T10:48:51.000Z","updated_at":"2025-06-08T23:04:45.000Z","dependencies_parsed_at":"2024-01-08T21:14:51.578Z","dependency_job_id":"f37d2d19-ffb0-4061-95a0-5bb51049bdd1","html_url":"https://github.com/EruEri/oyomu","commit_stats":null,"previous_names":["erueri/oyomu"],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EruEri%2Foyomu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EruEri%2Foyomu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EruEri%2Foyomu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EruEri%2Foyomu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EruEri","download_url":"https://codeload.github.com/EruEri/oyomu/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EruEri%2Foyomu/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259192199,"owners_count":22819433,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["cli","comics-collection","comics-reader","epub-reader","ocaml","terminal"],"created_at":"2024-11-13T00:13:49.162Z","updated_at":"2025-06-11T03:36:31.852Z","avatar_url":"https://github.com/EruEri.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Oyomu\n\nThe source code is now hosted on [Codeberg](https://codeberg.org/EruEri/oyomu)\n\n**oyomu** is a command line comic collection manager and also a comic reader.\n\n\nYour terminal should at least support one of this format for the page to be somewhat readable:\n- Sixels\n- Iterm\n- Kitty\n\n**oyomu** supports zip archives _(.cbz or .zip)_ and to some \nextend epub archives _(.epub)_\n\n### How to use\n\n#### Read\n\nTo read comics, use the ```read``` subcommand\n\nBy default, it uses the \"h\" for left and the \"l\" for right and 'q' for quit\n```\n$ oyomu read --help\nNAME\n       oyomu-read - Read comics\n\nSYNOPSIS\n       oyomu read [--pixel=PIXEL_MODE] [OPTION]… \u003cFILES.(cbz|zip|epub)\u003e…\n\nDESCRIPTION\n       Read commic\n\nARGUMENTS\n       \u003cFILES.(cbz|zip|epub)\u003e (required)\n           Archive of the comic. The archives must be zip archive\n\nOPTIONS\n       -p PIXEL_MODE, --pixel=PIXEL_MODE (absent=symbols)\n           pixel mode to use to render the images one of 'symbols', 'sixels',\n           'kitty' or 'iterm'\n```\n\n[Demonstration: MacOS iTerm](https://imgur.com/a/7pRl4j1)\n\n#### Collection\n\nThe ```collection``` subcommand allows you to handle your collection\n\n````\n$ oyomu collection --help\nNAME\n       oyomu-collection - Manage Oyomu collection\n\nSYNOPSIS\n       oyomu collection COMMAND …\n\nDESCRIPTION\n       oyomu collection allows you to manager and read your comic collection\n\nCOMMANDS\n       add [OPTION]… \u003cFILES.(cbz|zip|epub)\u003e…\n           Add comics to the collection\n\n       delete [--all=COMIC] [--encrypt] [OPTION]… [\u003cVOL.COMIC\u003e]…\n           Delete comics from collection\n\n       init [--encryption] [--force] [OPTION]…\n           Initialise the comics collection\n\n       list [--encrypt] [--name-only] [OPTION]… [SERIE]…\n           List series in collection\n\n       read [--all=COMIC] [--encrypt] [--pixel=PIXEL_MODE] [OPTION]…\n       [\u003cVOL.COMIC\u003e]…\n           Read comics from collection\n````\n\n##### Init\n\nTo Initialize the collection use ```ìnit``` subcommand\n\nOyomu has 2 strategies to store your comic:\n- Normal:\n    - Your comics are stored in your **$XDG_DATA_HOME/oyomu/comics** directory where each folder holds the volumes of the serie\n- Encrypted:\n    - Your comics are stored in your **$XDG_DATA_HOME/oyomu/.scomics** directory and are encrypted with a password that the ```ìnit``` \n    wizard will ask you to set if the option **--encryption** is set\n\n\n##### Add / Delete / List\n\n- Those subcommands do are respectively add, delete and list comics\n\n##### Read\n- You can also read comics within your collection with the ```read``` subcommand of ```oyomu collection```\n\n### Installation\n- First you will need to install those opam packages.\n    ```sh\n    $ opam install dune xdg camlzip cmdliner digestif dune-configurator mirage-crypto yojson ppx_deriving_yojson oepub re\n    ```\n\n- You will also need to install those C libraries:\n  - [Chafa](https://github.com/hpjansson/chafa)\n    - Chafa \u003e= 1.12.4 (maybe should work with chafa \u003e= 1.12.0)\n  - [ImageMagick](https://github.com/imagemagick/imagemagick)\n    - ImageMagick \u003e= 7.0.0\n    \n  The C libraries must be found by **pkg-config**\n\nBy default the prefix install is `/usr/local`. So oyomu binary is installed in `/usr/local/bin` and the man pages in `/usr/local/share/man`. \nBut the `make install` rule reacts to 3 variables:\n- `PREFIX`: \n  - default: `/usr/local`\n- `BINDIR`: \n    - default: `$(PREFIX)/bin`\n- `MANDIR`: \n    - default: `$(PREFIX)/share/man`\n\n```sh\n$ git clone https://codeberg.org/EruEri/oyomu\n$ cd oyomu\n$ make \n$ make install\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferueri%2Foyomu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ferueri%2Foyomu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferueri%2Foyomu/lists"}