Honzo is open source under Apache 2.0. Contributions are welcome. You can submit bug reports, feature requests, documentation improvements, and code changes.

Quick start

Prerequisites: just (command runner), Rust 1.75+, Node.js 18+.

git clone https://github.com/Nisoku/Honzo
cd Honzo
just setup
just check

What to work on

  • Bug fixes. Check the issue tracker for tagged issues.
  • Format extensions. New EXTRA namespaces, chunk types, or compression algorithms.
  • New adapters. Python, Java, Go, and Swift bindings are all welcome.
  • Documentation. This site is in Docs/, built with docmd.
  • Demo improvements. The demo apps are in Demo/.

Guidelines

Before submitting a PR, run all surface checks:

just check

This runs Rust formatting, linting, testing, WASM no_std verification, TypeScript typechecking, demo build, and docs build in sequence.

To run individual checks instead:

cargo test --workspace
cargo clippy -- -D warnings
cargo fmt --check

Update CHANGELOG.md with notable changes before submitting.

Pages in this section

Building
Architecture
Previous Demo Apps Next Building