This plugin only works on tauri v2, if you need the v1 plugin, feel free to submit a PR!
What is the difference with @tauri-apps/plugin-fs?
The stat method of @tauri-apps/plugin-fs supports only files when getting size, while the metadata method of tauri-plugin-fs-pro supports both files and directories when getting size. And some additional methods are provided. More methods will be expanded in the future.
iShot_2025-04-15_11.23.04.mp4
| Platform | Supported |
|---|---|
| Windows | ✅ |
| macOS | ✅ |
| Linux | ✅ |
| Android | ❌ |
| iOS | ❌ |
cargo add tauri-plugin-fs-proYou can install the JavaScript Guest bindings using your preferred JavaScript package manager:
pnpm add tauri-plugin-fs-pro-apisrc-tauri/src/lib.rs
pub fn run() { tauri::Builder::default() + .plugin(tauri_plugin_fs_pro::init()) .run(tauri::generate_context!()) .expect("error while running tauri application"); }src-tauri/capabilities/default.json
{ ... "permissions": [ ... + "fs-pro:default" ] }Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
import { isExist } from "tauri-plugin-fs-pro-api"; const exists = await isExist("/Users/xxx/EcoPaste.txt"); console.log(exists); // true| Method | Description |
|---|---|
isExist | Check if a path exists. |
isFile | Check if a path is a file. |
isDir | Check if a path is a directory. |
size | Get the size of the path, or 0 if it does not exist. |
name | Get the name of the path. |
extname | Get the extension name of the path. |
fullName | Get the full name of a file or directory including extension. |
parentName | Get the parent name of the path. |
getDefaultSaveIconPath | Get the default save icon path. |
icon | Get the icon of the path. |
metadata | Get the metadata of the path. |
compress | Compress the source path into a tar.gz file to the destination path. |
decompress | Decompress the tar.gz file from the source path to the destination path. |
transfer | Move the source path to the destination path. |
git clone https://github.com/ayangweb/tauri-plugin-fs-pro.gitpnpm install pnpm build cd examples/tauri-app pnpm install pnpm tauri dev-
Use file_icon_provider and image to get the system icon for a path.
-
Use fs_extra to implement the move path.