Bitcache

Bitcache is a distributed content-addressable storage (CAS) system.

[Features] | [Prerequisites] | [Installation] | [Examples] | [Reference] | [Development]

✨ Features

• Available both as the command-line tool bitcache and a Rust library.
• 100% pure and safe Rust with minimal dependencies and no bloat.
• Designed for #![no_std] environment compatibility from the get-go.
• Supports opting out of any feature using comprehensive feature flags.
• Adheres to the Rust API Guidelines in its naming conventions.
• Polyglot software also (soon!) available for Dart, Python, Ruby, and TypeScript.
• Cuts red tape: 100% free and unencumbered public domain software.

🛠️ Prerequisites

• Rust 1.88+

⬇️ Installation

Installation of the CLI

Installation via Cargo Binstall

cargo binstall -y bitcache

Installation via mise

mise use -g github:artob/bitcache

Installation via Cargo

cargo install bitcache --locked --features=cli

Downloading Release Tarballs

wget https://github.com/artob/bitcache/releases/download/0.0.1/bitcache-aarch64-apple-darwin.tar.xz
wget https://github.com/artob/bitcache/releases/download/0.0.1/bitcache-aarch64-unknown-linux-gnu.tar.xz
wget https://github.com/artob/bitcache/releases/download/0.0.1/bitcache-x86_64-apple-darwin.tar.xz
wget https://github.com/artob/bitcache/releases/download/0.0.1/bitcache-x86_64-pc-windows-msvc.zip
wget https://github.com/artob/bitcache/releases/download/0.0.1/bitcache-x86_64-unknown-linux-gnu.tar.xz

Installation of the Library

Installation from Crates.io

cargo add bitcache

Configuration in Cargo.toml

Enable all default features:

[dependencies]
bitcache = { version = "0" }

Enable only specific features:

[dependencies]
bitcache = { version = "0", default-features = false, features = ["alloc"] }

👉 Examples

Importing the Library

use bitcache::*;

📚 Reference

docs.rs/bitcache

Command-Line Interface

$ bitcache --help

Feature Flags

Interoperability

👨‍💻 Development

git clone https://github.com/artob/bitcache.git