📦 tauri-apps / tauri-plugin-fs

Access the file system.

Install

This plugin requires a Rust version of at least 1.77.2

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

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

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

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.