README.md

RedisFS

Redis File Server. A CLI tool to use any Redis instance to store and transfer files.

Status: ✅ Released!

About • Tech Stack • Usage • Contact

About

RedisFS allows you to easily store and download files inside of a Redis instance for lost latency access.

Tech Stack

 

Installation

To use this project, follow the steps above:

# Using crates.io
cargo install redisfs

# Build using cargo
git clone https://github.com/BuyMyMojo/RedisFS.git
cd RedisFS
cargo build --release

Usage

To use this project, follow the steps above:

# Upload files
redisfs push <FILE_PATH> <FILE_KEY>

# Download file
redisfs clone <OUT_PATH> <FILE_KEY>

# Check file memory usage
redisfs usage <FILE_KEY>

# List all files
redisfs list

# Delte key
redisfs delete <FILE_KEY>

# Use a redis server with a password but no username
redisfs -r "redis://:[password]@[address]:[password]" list
# The : is required

# Use a redis server with a password and username
redisfs -r "redis://[username]:[password]@[address]:[password]" list

Contact

Made with ❤️ by Owen Quinlan, get in touch!