Installation

There are multiple ways to install the shiroa CLI tool. Choose any one of the methods below that best suit your needs.

Executable binaries are available for download on the GitHub Releases page or the “Artifacts” section of each workflow run in CI workflow. Download the binary for your platform (Windows, macOS, or Linux) and extract the archive. The archive contains an shiroashiroa executable which you can run to build your books.

To make it easier to run, put the path to the binary into your PATHPATH.

shiroashiroa executable can be built with precompiled frontend artifacts using cargocargo.

First, follow the instructions on the Rust installation page to install cargocargo. shiroa currently requires at least Rust version 1.88.

Then, run the following commands:

cargo install --git https://github.com/Myriad-Dreamin/shiroa --locked shiroa

cargo install --git https://github.com/Myriad-Dreamin/shiroa --locked shiroa

To build the shiroashiroa’s all components from source, you need to additionally install Yarn. First, follow the instructions on the Yarn installation page.

Then, run the following commands:

git clone https://github.com/Myriad-Dreamin/shiroa.git
git submodule update --recursive --init
cargo run --bin shiroa-build
# optional: install it globally
cargo install --path ./cli

git clone https://github.com/Myriad-Dreamin/shiroa.git
git submodule update --recursive --init
cargo run --bin shiroa-build
# optional: install it globally
cargo install --path ./cli

With global installation, to uninstall, run the command cargo uninstall shiroacargo uninstall shiroa.

Again, make sure to add the Cargo bin directory to your PATHPATH.