Enterprise-grade, type-safe filesystem API with operator-based paths and rich path utilities; coroutine-backed suspend operations for read/write/copy/move/delete/list, Compose-first integration and high performance.
Enterprise-grade File System Library for Kotlin Multiplatform
A unified, type-safe file system API that works seamlessly across Android, iOS, Desktop, and Web.
Add the dependency to your build.gradle.kts:
// Common
implementation("in.sitharaj.krate:krate:1.0.0")
// Or platform-specific
implementation("in.sitharaj.krate:krate-android:1.0.0")
implementation("in.sitharaj.krate:krate-iosarm64:1.0.0")
implementation("in.sitharaj.krate:krate-desktop:1.0.0")
implementation("in.sitharaj.krate:krate-js:1.0.0")
// Create paths using the / operator
val path = KrateLocation.documents / "projects" / "myapp" / "config.json"
// Path properties
path.name // "config.json"
path.extension // "json"
path.parent // documents/projects/myapp
// Sibling path
val backup = path.sibling("config.backup.json")
// App-private storage (safe for sensitive data)
KrateLocation.appData
// Cache directory (may be cleared by system)
KrateLocation.cache
// User documents (accessible on some platforms)
KrateLocation.documents
// Temporary directory
KrateLocation.temp
// Read as bytes
val bytes: ByteArray = krate.read(path)
// Read as text
val text: String = krate.readText(path)
// Safe read (returns null if not found)
val bytesOrNull: ByteArray? = krate.readOrNull(path)
// Write bytes
krate.write(path, byteArray)
// Write text
krate.writeText(path, "Hello, World!")
// Append to file
krate.writeText(path, "\nNew line", append = true)
// Check existence
val exists: Boolean = krate.exists(path)
// Delete file
val deleted: Boolean = krate.delete(path)
// Copy file
krate.copy(source, destination, overwrite = true)
// Move file
krate.move(source, destination, overwrite = true)
// Get metadata
val metadata: FileMetadata = krate.metadata(path)
// Create directory
krate.createDirectory(path)
// List contents
val entries: List<KrateEntry> = krate.list(path)
// Delete directory
krate.deleteDirectory(path, recursive = true)
┌─────────────────────────────────────────────────────────────┐
│ Krate API (Common) │
│ ┌──────────┐ ┌──────────┐ ┌───────────┐ ┌───────────────┐ │
│ │ read() │ │ write() │ │ copy() │ │ list() │ │
│ └──────────┘ └──────────┘ └───────────┘ └───────────────┘ │
├─────────────────────────────────────────────────────────────┤
│ Android │ iOS │ Desktop │ Browser │
│ ────────── │ ──────────── │ ───────── │ ──────── │
│ java.nio.file │ FileManager │ java.nio │ OPFS │
│ SAF support │ Foundation │ Files API │ Modern API │
└─────────────────────────────────────────────────────────────┘
try {
val content = krate.read(path)
} catch (e: KrateException) {
when (e.error) {
KrateError.FILE_NOT_FOUND -> println("File doesn't exist")
KrateError.PERMISSION_DENIED -> println("No permission")
KrateError.IO_ERROR -> println("I/O error occurred")
else -> println("Error: ${e.error}")
}
}
when (val result = krate.readResult(path)) {
is KrateResult.Success -> process(result.value)
is KrateResult.Failure -> handleError(result.error)
}
Copyright 2024 Sitharaj Seenivasan
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance the License.
You may obtain a copy of the License at
http:
Unless applicable law agreed to writing, software
distributed under the License distributed an BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
See the License the specific language governing permissions
limitations under the License.
KratePathrememberKrate() for seamless integration| Platform | Backend | Status |
|---|
| Android | java.nio.file / java.io.File | ✅ Full Support |
| iOS | FileManager / Foundation | ✅ Full Support |
| Desktop (JVM) | java.nio.file | ✅ Full Support |
| Browser (JS) | Origin Private File System (OPFS) | ✅ Full Support |
| Browser (WASM) | In-Memory Storage | ✅ Basic Support |
fun FileManagerScreen() {
val krate = rememberKrate()
val scope = rememberCoroutineScope()
Button(onClick = {
scope.launch {
// Write a file
val path = KrateLocation.documents / "notes" / "hello.txt"
krate.writeText(path, "Hello, Krate!")
// Read it back
val content = krate.readText(path)
println(content) // "Hello, Krate!"
// List directory
val files = krate.list(KrateLocation.documents)
files.forEach { entry ->
when (entry) {
is KrateEntry.File -> println("📄 ${entry.name} (${entry.size} bytes)")
is KrateEntry.Directory -> println("📁 ${entry.name}")
}
}
}
}) {
Text("Demo")
}
}
Surfaced from shared tags and platforms — no rankings paid for.