Files
tauri-plugins-workspace/plugins/fs
Lucas Fernandes Nogueira 5de7ebfc95 fix(fs): do not deserialize customFlags from IPC (#3634)
In plugins/fs/src/lib.rs OpenOptions, custom_flags was deserializable
from the `open` command arguments even though it is not in the TS types,
so a webview with a read-only permission set could pass arbitrary open(2)
flags such as O_TRUNC.

The field is now #[serde(skip)]; Rust callers still set it through
OpenOptionsExt. Rejecting write/truncate/create options of `open` under
read-only sets changes permission semantics and is deferred to v3.
2026-10-09 13:05:12 -03:00
..
2026-09-26 14:46:48 -03:00
2023-06-19 04:30:18 -07:00
2026-09-26 17:21:49 -03:00
2026-09-26 17:21:49 -03:00
2023-04-16 08:53:19 -03:00
2023-04-16 08:53:19 -03:00
2023-04-16 08:53:19 -03:00
2026-09-26 17:21:49 -03:00
2026-09-26 14:46:48 -03:00

plugin-fs

Access the file system.

Platform Supported
Linux ✓
Windows ✓
macOS ✓
Android ✓
iOS ✓

Install

This plugin requires a Rust version of at least 1.90

There are three general methods of installation that we can recommend.

  1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
  2. Pull sources directly from Github using git tags / revision hashes (most secure)
  3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)

Install the Core plugin by adding the following to your Cargo.toml file:

src-tauri/Cargo.toml

[dependencies]
tauri-plugin-fs = "2.0.0"
# alternatively with Git:
tauri-plugin-fs = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }

You can install the JavaScript Guest bindings using your preferred JavaScript package manager:

pnpm add @tauri-apps/plugin-fs
# or
npm add @tauri-apps/plugin-fs
# or
yarn add @tauri-apps/plugin-fs

Usage

First you need to register the core plugin with Tauri:

src-tauri/src/lib.rs

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_fs::init())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

Afterwards all the plugin's APIs are available through the JavaScript guest bindings:

import { stat } from '@tauri-apps/plugin-fs'

await stat('/path/to/file')

Contributing

PRs accepted. Please make sure to read the Contributing Guide before making a pull request.

Partners

CrabNebula

For the complete list of sponsors please visit our website and Open Collective.

License

Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.

MIT or MIT/Apache 2.0 where applicable.