classifier-contract 0.1.0

Generated compatibility classifier contract
Documentation
  • Coverage
  • 2.04%
    1 out of 49 items documented0 out of 13 items with examples
  • Size
  • Source code size: 93.43 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 898.28 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 4s Average build duration of successful builds.
  • all releases: 5s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • fontanierh/boxology
    0 0 44
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • fontanierh

Boxology

Boxology is an early-stage framework for building software as independent boxes that humans define and agents implement. Humans own box boundaries, typed interfaces, data models, and allowed connections; implementations can evolve behind compatible contracts.

V0 was completed on 2026-08-09. The accepted stream specs describe its delivered boundary. Applications built with Boxology are separate products and are not included in this repository.

The first public tool release is planned as version 0.1.0 on crates.io, but it has not been published yet. Building this checkout requires Rust 1.97.1.

Quick start

Until the crates.io release is published, install the initializer and checker from this repository, then initialize an existing empty target directory (a lone .git is allowed):

cargo install --git https://github.com/fontanierh/boxology --locked boxology-init
cargo install --git https://github.com/fontanierh/boxology --locked boxology-cli
boxology-init --name example --target <empty-directory>
cd <empty-directory>
cargo build --workspace
boxology check

After 0.1.0 is published, the registry installation commands will be:

cargo install boxology-init --locked
cargo install boxology-cli --locked

At that point, update with cargo install --force boxology-init --locked and cargo install --force boxology-cli --locked; add --version 0.1.0 to pin the release.

The generated project README owns that project's invocation contract.

Release procedure

Run cargo xtask ci --base origin/main, then cargo xtask release preflight. Preflight checks the exact 0.1.0 closure and order, inspects every crate's planned file inventory (including README and both licenses), and creates, verifies, and inspects the real dependency-free root .crate. It does not claim to package dependent crates: Cargo requires their predecessors to be visible on crates.io.

Configure Cargo's crates.io credentials securely, then publish exactly the next crate shown by the order using BOXOLOGY_RELEASE_PUBLISH=1 cargo xtask release publish <crate-name>. Each invocation recognizes the already-visible prefix, rejects gaps or an out-of-order name, runs a real crates.io publish dry-run, and publishes only that crate. Wait for it to become visible before invoking the next. After the sequence, prove fresh registry installs with the Quick start commands and smoke-test boxology --help plus an initialized project. Tests and preflight never publish.

Documentation

See the changelog for release preparation and known boundaries. Start with the concise white paper, then use its linked sections to open the detailed documents. The product contract separates long-term direction from the completed foundation milestone.

License

Boxology is dual-licensed under MIT or Apache License 2.0, at your option.

Contributing and security

See CONTRIBUTING.md before proposing a change and SECURITY.md before reporting a vulnerability. Community participation is governed by the Contributor Covenant.