Important
6cy is under active development and is not yet stable. The file format and APIs may change without notice.
Note
This project is intended for benchmarking, research, and ecosystem prototyping. It is not recommended for production use yet.
Sixcy is a modern, efficient, and robust container format designed for high-performance data storage and transmission. It is built with a focus on streaming efficiency, data recoverability, and flexible compression strategies.
- Streaming-First Design: Optimized for single-pass read and write operations, making it ideal for network streams and large-scale data processing.
- Data Recoverability: Includes self-describing blocks and periodic checkpoints to ensure data can be recovered even if the archive is truncated or partially corrupted.
- Codec Polymorphism: Supports multiple compression algorithms (Zstd, LZ4, etc.) within a single archive, allowing for block-level optimization based on data type.
- Plugin Architecture: Supports third-party and proprietary compression algorithms through a well-defined plugin interface, enabling closed-source extensions to integrate seamlessly.
- Metadata-First Indexing: Provides a centralized index for fast random access and efficient file listing without scanning the entire archive.
- Rust Reference Implementation: A high-performance, memory-safe implementation that serves as the canonical reference for the Sixcy specification.
src/: Core library and CLI implementation.lib.rs: Library entry point.superblock.rs: Fixed header management.block.rs: Data block encoding and decoding.codec/: Compression algorithm implementations and plugin interface.index/: File index and metadata management.recovery/: Data recovery and checkpointing logic.io_stream/: High-level streaming I/O interfaces.
tests/: Integration tests for format validation.benches/: Performance benchmarks for compression and I/O.spec.md: Detailed binary format specification.security.md: Public security profile and threat model.
Go to Environmental_preparation.md to view Environmental preparation
The compiled CLI tool will be available at target/release/6cy.
Note
What This Build Provides The open-source build includes:
- .6cy container format implementation
- Streaming I/O engine
- Recovery logic
- Standard codecs (Zstd / LZ4)
- Plugin ABI for external codecs
- Proprietary codecs and optimization
- components are not part of
- the open-source tree. They can be
- integrated via the plugin interface.
cd C:\sixcy\target\releaseWindows run
Note
Before running any commands, make sure you are in this directory
Linux&MacOS run
chmod +x 6cy
./6cy --helpYou will see pack,unpack,list,info,optimize
- Specification: The full binary format specification is available in spec.md.
- Security: Security considerations and reporting procedures are detailed in security.md.
v0.1.x (current) Provides the reference implementation of the .6cy container format, streaming engine, and plugin interface.
This version is intended for:
- Format validation
- Integration testing
- Research and benchmarking
v0.2.0 (planned) Will introduce the official runtime package and extended codec support.
If you are looking for a ready-to-use build, please wait for the v0.2.0 release.
This project uses different licenses for the specification and the implementation:
- Specification (
spec.md): Licensed under CC-BY-4.0. - Implementation (
src/,tests/,benches/, etc.): Licensed under Apache-2.0.
Sixcy - Speed, Safety, and Flexibility in Data Containment.