This directory contains the Rust crates and their tools. It has the following structure:
- The
cli
directory contains the Magika Rust CLI. It is published on crates.io asmagika-cli
. It can be compiled withcargo build --release
from thecli
directory. The output binary will betarget/release/magika
. - The
lib
directory contains the Magika Rust library. It is published on crates.io asmagika
. - The
gen
directory is for maintainers when a new model is available. - The
test.sh
script tests the crates listed above. It runs as part of the Github continuous integration. - The
sync.sh
script updates the library when a new model is available using thegen
crate. - The
publish.sh
script prepares the library and the CLI for publishing to crates.io. It generates a commit that must be merged first. - The
color.sh
is a shell library for the scripts above. - The remaining files have the usual meaning associated to their name.