ProkaFS - The filesystem of ProkaOS

Copyright (C) RainSTR Studio 2026, All rights reserved.

---

For more documentations, please click here.

Welcome to use ProkaFS, which is prepared for ProkaOS. Primarily for practice, and we hope this can be supported in more operating systems.

Project Highlights

• Memory safe: Written in Rust, which is very safe in memory;
• Lightweight: The filesystem is very lightweight, and it can be used in embedded systems;
• Multiple Filesystem Type: Supports 2 file system type, in order to adapt different disk space.
• Separated modules: The filesystem is separated into 2 modules, which are proka-fs and pkfs-utils.

How-to-build

Requirements

• Rust: ProkaFS is written in Rust, so you need a Rust compiler.

Steps

1. Install necessary components

We suggest you to use rustup to install Rust.

# This command is from https://rustup.rs
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source $HOME/.cargo/env

2. Clone the repository After installing these tools, clone this repository.

# Origin address
git clone https://github.com/RainSTR-Studio/proka-fs.git

# If you are in China, this address might faster than original one.
git clone https://ghfast.top/https://github.com/RainSTR-Studio/proka-fs.git

3. Build the project

Execute the following commands to build the project.

cd proka-fs
cargo build --release

This will generate these executable files in target/release:

• mkpkfs: The ProkaFS creator;
• ckpkfs: The checker and fixer of ProkaFS (todo)

For more usages, please type <command> --help in the terminal.

Contributors

Thanks to all contributors who have helped improve ProkaFS:

• zhangxuan2011 zx20110412@outlook.com

If you want to contribute to this project, you can follow the guide in CONTRIBUTING.md.

Leave your name here

By the way, don't forget to add your name in these positions:

• Contributors List;
• Cargo metadata in fs/Cargo.toml;
• Cargo metadata in utils/Cargo.toml;

Open Source License

This project is currently using GPL-3.0 license. See LICENSE for more details.