#interface #command-line-interface #local #aligner #documentation #sequence #kbo

app kbo-cli

Command-line interface to the kbo local aligner

1 unstable release

new 0.1.0 Nov 18, 2024

#2 in #aligner

MIT/Apache

24KB
420 lines

kbo-cli

Command-line interface for the kbo local aligner.

Documentation is available at https://docs.rs/kbo.

Installation

Cargo

Run cargo install kbo-cli.

From source

Run

git clone https://github.com/tmaklin/kbo-cli
cd kbo-cli
cargo build --release

This will build the kbo executable in target/release/kbo directory.

Usage

kbo-cli provides access to two main operations:

  • kbo find matches the k-mers in a query sequence with the reference and reports the local alignment segments found within the reference. Find is useful for problems that can be solved with blast.
  • kbo map maps the query sequence against a reference sequence, and reports the nucleotide sequence of the alignment relative to the reference. Map solves the same problem as snippy and ska map.

For usage instructions, see the documentation at https://docs.rs/kbo.

License

kbo-cli is dual-licensed under the MIT and Apache 2.0 licenses.

Dependencies

~12–22MB
~287K SLoC