Skip to content

Latest commit

 

History

History
53 lines (39 loc) · 1.39 KB

File metadata and controls

53 lines (39 loc) · 1.39 KB

CompressKit Agent Guide

Project Identity

Core Contract

Four algorithms (Huffman, Arithmetic, Range, RLE) × three languages (C++17, Go, Rust). Binary format compatibility is the primary constraint.

Magic Numbers:

Algorithm Magic
Huffman HFMN
Arithmetic AENC
Range Coder RCNC
RLE RLE\x00

Validation Commands

Command Purpose
make build Build all CLIs
make test Full test suite
make test-conformance Cross-language matrix
make lint All linters
npm run docs:build Build documentation
openspec validate --all Validate specs

Key Constraints

  • Maintain cross-language binary format compatibility
  • Security limits: 4 GiB input, 1 GiB output
  • Range Coder performance limitation on large files is documented
  • Error messages in code must be English

Change Policy

OpenSpec change required for:

  • Binary format changes
  • New algorithms
  • Public API changes
  • Cross-language conformance semantics

Small documentation fixes, internal refactors, and bug fixes that preserve existing contract may be implemented directly.

Reference

See openspec/specs/ for full requirements.