File System

GitHub npm crates.io

API Reference

Access the file system.

Supported Platforms

• Windows
• Linux
• macOS

Setup

This plugin requires a Rust version of at least 1.75

Install the fs plugin to get started.

Automatic

Use your project’s package manager to add the dependency:

npm

npm run tauri add fs

Yarn

yarn run tauri add fs

pnpm

pnpm tauri add fs

Cargo

cargo tauri add fs

Manual

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

   src-tauri/Cargo.toml

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

2. Modify lib.rs to initialize the plugin:

   src-tauri/src/lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   fn run() {
     tauri::Builder::default()
       .plugin(tauri_plugin_fs::init())
       .run(tauri::generate_context!())
       .expect("error while running tauri application");
   }

3. Install the JavaScript Guest bindings using your preferred JavaScript package manager:

   npm

   npm install @tauri-apps/plugin-fs

   Yarn

   yarn add @tauri-apps/plugin-fs

   pnpm

   pnpm add @tauri-apps/plugin-fs

Usage

The fs plugin is available in both JavaScript and Rust.

JavaScript

import { exists, BaseDirectory } from '@tauri-apps/plugin-fs';

// Check if the `$APPDATA/avatar.png` file exists
await exists('avatar.png', { baseDir: BaseDirectory.AppData });

Rust

src-tauri/src/lib.rs

use tauri_plugin_fs::FsExt;

#[cfg_attr(mobile, tauri::mobile_entry_point)]
fn run() {
  tauri::Builder::default()
      .plugin(tauri_plugin_fs::init())
      .setup(|app| {
          // allowed the given directory
          let scope = app.fs_scope();
          scope.allow_directory("/path/to/directory", false);
          dbg!(scope.allowed());

          Ok(())
       })
       .run(tauri::generate_context!())
       .expect("error while running tauri application");
}

Security

This module prevents path traversal, not allowing absolute paths or parent dir components (i.e. /usr/path/to/file or ../path/to/file paths are not allowed). Paths accessed with this API must be relative to one of the base directories so if you need access to arbitrary file system paths, you must write such logic on the core layer instead.

See @tauri-apps/plugin-fs - Security for more information.

Permissions

By default all plugin commands are blocked and cannot be accessed. You must define a list of permissions in your capabilities configuration.

See Access Control List for more information.

src-tauri/capabilities/main.json

{
  "$schema": "../gen/schemas/desktop-schema.json",
  "identifier": "main-capability",
  "description": "Capability for the main window",
  "windows": ["main"],
  "permissions": [
    "fs:default",
    {
      "identifier": "fs:allow-exists",
      "allow": [{ "path": "$APPDATA/*" }]
    }
  ]
}

Default Permissions

This configuration file defines the default permissions granted to the filesystem.

Granted Permissions

This default permission set enables all read-related commands and allows access to the $APP folder and sub directories created in it. The location of the $APP folder depends on the operating system, where the application is run.

In general the $APP folder needs to be manually created by the application at runtime, before accessing files or folders in it is possible.

Denied Permissions

This default permission set prevents access to critical components of the Tauri application by default. On Windows the webview data folder access is denied.

Permission	Description
fs:default
fs:deny-default	This denies access to dangerous Tauri relevant files and folders by default.

Scope Permissions

Permission	Description
fs:allow-app-read-recursive	This allows full recursive read access to the complete $APP folder, files and subdirectories.
fs:allow-app-write-recursive	This allows full recusrive write access to the complete $APP folder, files and subdirectories.
fs:allow-app-read	This allows non-recursive read access to the $APP folder.
fs:allow-app-write	This allows non-recursive write access to the $APP folder.
fs:allow-app-meta-recursive	This allows read access to metadata of the $APP folder, including file listing and statistics.
fs:allow-app-meta	This allows read access to metadata of the $APP folder, including file listing and statistics.
fs:scope-app-recursive	This scope recursive access to the complete $APP folder, including sub directories and files.
fs:scope-app	This scope permits access to all files and list content of top level directories in the $APPfolder.
fs:scope-app-index	This scope permits to list all files and folders in the $APPfolder.
fs:allow-appcache-read-recursive	This allows full recursive read access to the complete $APPCACHE folder, files and subdirectories.
fs:allow-appcache-write-recursive	This allows full recusrive write access to the complete $APPCACHE folder, files and subdirectories.
fs:allow-appcache-read	This allows non-recursive read access to the $APPCACHE folder.
fs:allow-appcache-write	This allows non-recursive write access to the $APPCACHE folder.
fs:allow-appcache-meta-recursive	This allows read access to metadata of the $APPCACHE folder, including file listing and statistics.
fs:allow-appcache-meta	This allows read access to metadata of the $APPCACHE folder, including file listing and statistics.
fs:scope-appcache-recursive	This scope recursive access to the complete $APPCACHE folder, including sub directories and files.
fs:scope-appcache	This scope permits access to all files and list content of top level directories in the $APPCACHEfolder.
fs:scope-appcache-index	This scope permits to list all files and folders in the $APPCACHEfolder.
fs:allow-appconfig-read-recursive	This allows full recursive read access to the complete $APPCONFIG folder, files and subdirectories.
fs:allow-appconfig-write-recursive	This allows full recusrive write access to the complete $APPCONFIG folder, files and subdirectories.
fs:allow-appconfig-read	This allows non-recursive read access to the $APPCONFIG folder.
fs:allow-appconfig-write	This allows non-recursive write access to the $APPCONFIG folder.
fs:allow-appconfig-meta-recursive	This allows read access to metadata of the $APPCONFIG folder, including file listing and statistics.
fs:allow-appconfig-meta	This allows read access to metadata of the $APPCONFIG folder, including file listing and statistics.
fs:scope-appconfig-recursive	This scope recursive access to the complete $APPCONFIG folder, including sub directories and files.
fs:scope-appconfig	This scope permits access to all files and list content of top level directories in the $APPCONFIGfolder.
fs:scope-appconfig-index	This scope permits to list all files and folders in the $APPCONFIGfolder.
fs:allow-appdata-read-recursive	This allows full recursive read access to the complete $APPDATA folder, files and subdirectories.
fs:allow-appdata-write-recursive	This allows full recusrive write access to the complete $APPDATA folder, files and subdirectories.
fs:allow-appdata-read	This allows non-recursive read access to the $APPDATA folder.
fs:allow-appdata-write	This allows non-recursive write access to the $APPDATA folder.
fs:allow-appdata-meta-recursive	This allows read access to metadata of the $APPDATA folder, including file listing and statistics.
fs:allow-appdata-meta	This allows read access to metadata of the $APPDATA folder, including file listing and statistics.
fs:scope-appdata-recursive	This scope recursive access to the complete $APPDATA folder, including sub directories and files.
fs:scope-appdata	This scope permits access to all files and list content of top level directories in the $APPDATAfolder.
fs:scope-appdata-index	This scope permits to list all files and folders in the $APPDATAfolder.
fs:allow-applocaldata-read-recursive	This allows full recursive read access to the complete $APPLOCALDATA folder, files and subdirectories.
fs:allow-applocaldata-write-recursive	This allows full recusrive write access to the complete $APPLOCALDATA folder, files and subdirectories.
fs:allow-applocaldata-read	This allows non-recursive read access to the $APPLOCALDATA folder.
fs:allow-applocaldata-write	This allows non-recursive write access to the $APPLOCALDATA folder.
fs:allow-applocaldata-meta-recursive	This allows read access to metadata of the $APPLOCALDATA folder, including file listing and statistics.
fs:allow-applocaldata-meta	This allows read access to metadata of the $APPLOCALDATA folder, including file listing and statistics.
fs:scope-applocaldata-recursive	This scope recursive access to the complete $APPLOCALDATA folder, including sub directories and files.
fs:scope-applocaldata	This scope permits access to all files and list content of top level directories in the $APPLOCALDATAfolder.
fs:scope-applocaldata-index	This scope permits to list all files and folders in the $APPLOCALDATAfolder.
fs:allow-applog-read-recursive	This allows full recursive read access to the complete $APPLOG folder, files and subdirectories.
fs:allow-applog-write-recursive	This allows full recusrive write access to the complete $APPLOG folder, files and subdirectories.
fs:allow-applog-read	This allows non-recursive read access to the $APPLOG folder.
fs:allow-applog-write	This allows non-recursive write access to the $APPLOG folder.
fs:allow-applog-meta-recursive	This allows read access to metadata of the $APPLOG folder, including file listing and statistics.
fs:allow-applog-meta	This allows read access to metadata of the $APPLOG folder, including file listing and statistics.
fs:scope-applog-recursive	This scope recursive access to the complete $APPLOG folder, including sub directories and files.
fs:scope-applog	This scope permits access to all files and list content of top level directories in the $APPLOGfolder.
fs:scope-applog-index	This scope permits to list all files and folders in the $APPLOGfolder.
fs:allow-audio-read-recursive	This allows full recursive read access to the complete $AUDIO folder, files and subdirectories.
fs:allow-audio-write-recursive	This allows full recusrive write access to the complete $AUDIO folder, files and subdirectories.
fs:allow-audio-read	This allows non-recursive read access to the $AUDIO folder.
fs:allow-audio-write	This allows non-recursive write access to the $AUDIO folder.
fs:allow-audio-meta-recursive	This allows read access to metadata of the $AUDIO folder, including file listing and statistics.
fs:allow-audio-meta	This allows read access to metadata of the $AUDIO folder, including file listing and statistics.
fs:scope-audio-recursive	This scope recursive access to the complete $AUDIO folder, including sub directories and files.
fs:scope-audio	This scope permits access to all files and list content of top level directories in the $AUDIOfolder.
fs:scope-audio-index	This scope permits to list all files and folders in the $AUDIOfolder.
fs:allow-cache-read-recursive	This allows full recursive read access to the complete $CACHE folder, files and subdirectories.
fs:allow-cache-write-recursive	This allows full recusrive write access to the complete $CACHE folder, files and subdirectories.
fs:allow-cache-read	This allows non-recursive read access to the $CACHE folder.
fs:allow-cache-write	This allows non-recursive write access to the $CACHE folder.
fs:allow-cache-meta-recursive	This allows read access to metadata of the $CACHE folder, including file listing and statistics.
fs:allow-cache-meta	This allows read access to metadata of the $CACHE folder, including file listing and statistics.
fs:scope-cache-recursive	This scope recursive access to the complete $CACHE folder, including sub directories and files.
fs:scope-cache	This scope permits access to all files and list content of top level directories in the $CACHEfolder.
fs:scope-cache-index	This scope permits to list all files and folders in the $CACHEfolder.
fs:allow-config-read-recursive	This allows full recursive read access to the complete $CONFIG folder, files and subdirectories.
fs:allow-config-write-recursive	This allows full recusrive write access to the complete $CONFIG folder, files and subdirectories.
fs:allow-config-read	This allows non-recursive read access to the $CONFIG folder.
fs:allow-config-write	This allows non-recursive write access to the $CONFIG folder.
fs:allow-config-meta-recursive	This allows read access to metadata of the $CONFIG folder, including file listing and statistics.
fs:allow-config-meta	This allows read access to metadata of the $CONFIG folder, including file listing and statistics.
fs:scope-config-recursive	This scope recursive access to the complete $CONFIG folder, including sub directories and files.
fs:scope-config	This scope permits access to all files and list content of top level directories in the $CONFIGfolder.
fs:scope-config-index	This scope permits to list all files and folders in the $CONFIGfolder.
fs:allow-data-read-recursive	This allows full recursive read access to the complete $DATA folder, files and subdirectories.
fs:allow-data-write-recursive	This allows full recusrive write access to the complete $DATA folder, files and subdirectories.
fs:allow-data-read	This allows non-recursive read access to the $DATA folder.
fs:allow-data-write	This allows non-recursive write access to the $DATA folder.
fs:allow-data-meta-recursive	This allows read access to metadata of the $DATA folder, including file listing and statistics.
fs:allow-data-meta	This allows read access to metadata of the $DATA folder, including file listing and statistics.
fs:scope-data-recursive	This scope recursive access to the complete $DATA folder, including sub directories and files.
fs:scope-data	This scope permits access to all files and list content of top level directories in the $DATAfolder.
fs:scope-data-index	This scope permits to list all files and folders in the $DATAfolder.
fs:allow-desktop-read-recursive	This allows full recursive read access to the complete $DESKTOP folder, files and subdirectories.
fs:allow-desktop-write-recursive	This allows full recusrive write access to the complete $DESKTOP folder, files and subdirectories.
fs:allow-desktop-read	This allows non-recursive read access to the $DESKTOP folder.
fs:allow-desktop-write	This allows non-recursive write access to the $DESKTOP folder.
fs:allow-desktop-meta-recursive	This allows read access to metadata of the $DESKTOP folder, including file listing and statistics.
fs:allow-desktop-meta	This allows read access to metadata of the $DESKTOP folder, including file listing and statistics.
fs:scope-desktop-recursive	This scope recursive access to the complete $DESKTOP folder, including sub directories and files.
fs:scope-desktop	This scope permits access to all files and list content of top level directories in the $DESKTOPfolder.
fs:scope-desktop-index	This scope permits to list all files and folders in the $DESKTOPfolder.
fs:allow-document-read-recursive	This allows full recursive read access to the complete $DOCUMENT folder, files and subdirectories.
fs:allow-document-write-recursive	This allows full recusrive write access to the complete $DOCUMENT folder, files and subdirectories.
fs:allow-document-read	This allows non-recursive read access to the $DOCUMENT folder.
fs:allow-document-write	This allows non-recursive write access to the $DOCUMENT folder.
fs:allow-document-meta-recursive	This allows read access to metadata of the $DOCUMENT folder, including file listing and statistics.
fs:allow-document-meta	This allows read access to metadata of the $DOCUMENT folder, including file listing and statistics.
fs:scope-document-recursive	This scope recursive access to the complete $DOCUMENT folder, including sub directories and files.
fs:scope-document	This scope permits access to all files and list content of top level directories in the $DOCUMENTfolder.
fs:scope-document-index	This scope permits to list all files and folders in the $DOCUMENTfolder.
fs:allow-download-read-recursive	This allows full recursive read access to the complete $DOWNLOAD folder, files and subdirectories.
fs:allow-download-write-recursive	This allows full recusrive write access to the complete $DOWNLOAD folder, files and subdirectories.
fs:allow-download-read	This allows non-recursive read access to the $DOWNLOAD folder.
fs:allow-download-write	This allows non-recursive write access to the $DOWNLOAD folder.
fs:allow-download-meta-recursive	This allows read access to metadata of the $DOWNLOAD folder, including file listing and statistics.
fs:allow-download-meta	This allows read access to metadata of the $DOWNLOAD folder, including file listing and statistics.
fs:scope-download-recursive	This scope recursive access to the complete $DOWNLOAD folder, including sub directories and files.
fs:scope-download	This scope permits access to all files and list content of top level directories in the $DOWNLOADfolder.
fs:scope-download-index	This scope permits to list all files and folders in the $DOWNLOADfolder.
fs:allow-exe-read-recursive	This allows full recursive read access to the complete $EXE folder, files and subdirectories.
fs:allow-exe-write-recursive	This allows full recusrive write access to the complete $EXE folder, files and subdirectories.
fs:allow-exe-read	This allows non-recursive read access to the $EXE folder.
fs:allow-exe-write	This allows non-recursive write access to the $EXE folder.
fs:allow-exe-meta-recursive	This allows read access to metadata of the $EXE folder, including file listing and statistics.
fs:allow-exe-meta	This allows read access to metadata of the $EXE folder, including file listing and statistics.
fs:scope-exe-recursive	This scope recursive access to the complete $EXE folder, including sub directories and files.
fs:scope-exe	This scope permits access to all files and list content of top level directories in the $EXEfolder.
fs:scope-exe-index	This scope permits to list all files and folders in the $EXEfolder.
fs:allow-font-read-recursive	This allows full recursive read access to the complete $FONT folder, files and subdirectories.
fs:allow-font-write-recursive	This allows full recusrive write access to the complete $FONT folder, files and subdirectories.
fs:allow-font-read	This allows non-recursive read access to the $FONT folder.
fs:allow-font-write	This allows non-recursive write access to the $FONT folder.
fs:allow-font-meta-recursive	This allows read access to metadata of the $FONT folder, including file listing and statistics.
fs:allow-font-meta	This allows read access to metadata of the $FONT folder, including file listing and statistics.
fs:scope-font-recursive	This scope recursive access to the complete $FONT folder, including sub directories and files.
fs:scope-font	This scope permits access to all files and list content of top level directories in the $FONTfolder.
fs:scope-font-index	This scope permits to list all files and folders in the $FONTfolder.
fs:allow-home-read-recursive	This allows full recursive read access to the complete $HOME folder, files and subdirectories.
fs:allow-home-write-recursive	This allows full recusrive write access to the complete $HOME folder, files and subdirectories.
fs:allow-home-read	This allows non-recursive read access to the $HOME folder.
fs:allow-home-write	This allows non-recursive write access to the $HOME folder.
fs:allow-home-meta-recursive	This allows read access to metadata of the $HOME folder, including file listing and statistics.
fs:allow-home-meta	This allows read access to metadata of the $HOME folder, including file listing and statistics.
fs:scope-home-recursive	This scope recursive access to the complete $HOME folder, including sub directories and files.
fs:scope-home	This scope permits access to all files and list content of top level directories in the $HOMEfolder.
fs:scope-home-index	This scope permits to list all files and folders in the $HOMEfolder.
fs:allow-localdata-read-recursive	This allows full recursive read access to the complete $LOCALDATA folder, files and subdirectories.
fs:allow-localdata-write-recursive	This allows full recusrive write access to the complete $LOCALDATA folder, files and subdirectories.
fs:allow-localdata-read	This allows non-recursive read access to the $LOCALDATA folder.
fs:allow-localdata-write	This allows non-recursive write access to the $LOCALDATA folder.
fs:allow-localdata-meta-recursive	This allows read access to metadata of the $LOCALDATA folder, including file listing and statistics.
fs:allow-localdata-meta	This allows read access to metadata of the $LOCALDATA folder, including file listing and statistics.
fs:scope-localdata-recursive	This scope recursive access to the complete $LOCALDATA folder, including sub directories and files.
fs:scope-localdata	This scope permits access to all files and list content of top level directories in the $LOCALDATAfolder.
fs:scope-localdata-index	This scope permits to list all files and folders in the $LOCALDATAfolder.
fs:allow-log-read-recursive	This allows full recursive read access to the complete $LOG folder, files and subdirectories.
fs:allow-log-write-recursive	This allows full recusrive write access to the complete $LOG folder, files and subdirectories.
fs:allow-log-read	This allows non-recursive read access to the $LOG folder.
fs:allow-log-write	This allows non-recursive write access to the $LOG folder.
fs:allow-log-meta-recursive	This allows read access to metadata of the $LOG folder, including file listing and statistics.
fs:allow-log-meta	This allows read access to metadata of the $LOG folder, including file listing and statistics.
fs:scope-log-recursive	This scope recursive access to the complete $LOG folder, including sub directories and files.
fs:scope-log	This scope permits access to all files and list content of top level directories in the $LOGfolder.
fs:scope-log-index	This scope permits to list all files and folders in the $LOGfolder.
fs:allow-picture-read-recursive	This allows full recursive read access to the complete $PICTURE folder, files and subdirectories.
fs:allow-picture-write-recursive	This allows full recusrive write access to the complete $PICTURE folder, files and subdirectories.
fs:allow-picture-read	This allows non-recursive read access to the $PICTURE folder.
fs:allow-picture-write	This allows non-recursive write access to the $PICTURE folder.
fs:allow-picture-meta-recursive	This allows read access to metadata of the $PICTURE folder, including file listing and statistics.
fs:allow-picture-meta	This allows read access to metadata of the $PICTURE folder, including file listing and statistics.
fs:scope-picture-recursive	This scope recursive access to the complete $PICTURE folder, including sub directories and files.
fs:scope-picture	This scope permits access to all files and list content of top level directories in the $PICTUREfolder.
fs:scope-picture-index	This scope permits to list all files and folders in the $PICTUREfolder.
fs:allow-public-read-recursive	This allows full recursive read access to the complete $PUBLIC folder, files and subdirectories.
fs:allow-public-write-recursive	This allows full recusrive write access to the complete $PUBLIC folder, files and subdirectories.
fs:allow-public-read	This allows non-recursive read access to the $PUBLIC folder.
fs:allow-public-write	This allows non-recursive write access to the $PUBLIC folder.
fs:allow-public-meta-recursive	This allows read access to metadata of the $PUBLIC folder, including file listing and statistics.
fs:allow-public-meta	This allows read access to metadata of the $PUBLIC folder, including file listing and statistics.
fs:scope-public-recursive	This scope recursive access to the complete $PUBLIC folder, including sub directories and files.
fs:scope-public	This scope permits access to all files and list content of top level directories in the $PUBLICfolder.
fs:scope-public-index	This scope permits to list all files and folders in the $PUBLICfolder.
fs:allow-resource-read-recursive	This allows full recursive read access to the complete $RESOURCE folder, files and subdirectories.
fs:allow-resource-write-recursive	This allows full recusrive write access to the complete $RESOURCE folder, files and subdirectories.
fs:allow-resource-read	This allows non-recursive read access to the $RESOURCE folder.
fs:allow-resource-write	This allows non-recursive write access to the $RESOURCE folder.
fs:allow-resource-meta-recursive	This allows read access to metadata of the $RESOURCE folder, including file listing and statistics.
fs:allow-resource-meta	This allows read access to metadata of the $RESOURCE folder, including file listing and statistics.
fs:scope-resource-recursive	This scope recursive access to the complete $RESOURCE folder, including sub directories and files.
fs:scope-resource	This scope permits access to all files and list content of top level directories in the $RESOURCEfolder.
fs:scope-resource-index	This scope permits to list all files and folders in the $RESOURCEfolder.
fs:allow-runtime-read-recursive	This allows full recursive read access to the complete $RUNTIME folder, files and subdirectories.
fs:allow-runtime-write-recursive	This allows full recusrive write access to the complete $RUNTIME folder, files and subdirectories.
fs:allow-runtime-read	This allows non-recursive read access to the $RUNTIME folder.
fs:allow-runtime-write	This allows non-recursive write access to the $RUNTIME folder.
fs:allow-runtime-meta-recursive	This allows read access to metadata of the $RUNTIME folder, including file listing and statistics.
fs:allow-runtime-meta	This allows read access to metadata of the $RUNTIME folder, including file listing and statistics.
fs:scope-runtime-recursive	This scope recursive access to the complete $RUNTIME folder, including sub directories and files.
fs:scope-runtime	This scope permits access to all files and list content of top level directories in the $RUNTIMEfolder.
fs:scope-runtime-index	This scope permits to list all files and folders in the $RUNTIMEfolder.
fs:allow-temp-read-recursive	This allows full recursive read access to the complete $TEMP folder, files and subdirectories.
fs:allow-temp-write-recursive	This allows full recusrive write access to the complete $TEMP folder, files and subdirectories.
fs:allow-temp-read	This allows non-recursive read access to the $TEMP folder.
fs:allow-temp-write	This allows non-recursive write access to the $TEMP folder.
fs:allow-temp-meta-recursive	This allows read access to metadata of the $TEMP folder, including file listing and statistics.
fs:allow-temp-meta	This allows read access to metadata of the $TEMP folder, including file listing and statistics.
fs:scope-temp-recursive	This scope recursive access to the complete $TEMP folder, including sub directories and files.
fs:scope-temp	This scope permits access to all files and list content of top level directories in the $TEMPfolder.
fs:scope-temp-index	This scope permits to list all files and folders in the $TEMPfolder.
fs:allow-template-read-recursive	This allows full recursive read access to the complete $TEMPLATE folder, files and subdirectories.
fs:allow-template-write-recursive	This allows full recusrive write access to the complete $TEMPLATE folder, files and subdirectories.
fs:allow-template-read	This allows non-recursive read access to the $TEMPLATE folder.
fs:allow-template-write	This allows non-recursive write access to the $TEMPLATE folder.
fs:allow-template-meta-recursive	This allows read access to metadata of the $TEMPLATE folder, including file listing and statistics.
fs:allow-template-meta	This allows read access to metadata of the $TEMPLATE folder, including file listing and statistics.
fs:scope-template-recursive	This scope recursive access to the complete $TEMPLATE folder, including sub directories and files.
fs:scope-template	This scope permits access to all files and list content of top level directories in the $TEMPLATEfolder.
fs:scope-template-index	This scope permits to list all files and folders in the $TEMPLATEfolder.
fs:allow-video-read-recursive	This allows full recursive read access to the complete $VIDEO folder, files and subdirectories.
fs:allow-video-write-recursive	This allows full recusrive write access to the complete $VIDEO folder, files and subdirectories.
fs:allow-video-read	This allows non-recursive read access to the $VIDEO folder.
fs:allow-video-write	This allows non-recursive write access to the $VIDEO folder.
fs:allow-video-meta-recursive	This allows read access to metadata of the $VIDEO folder, including file listing and statistics.
fs:allow-video-meta	This allows read access to metadata of the $VIDEO folder, including file listing and statistics.
fs:scope-video-recursive	This scope recursive access to the complete $VIDEO folder, including sub directories and files.
fs:scope-video	This scope permits access to all files and list content of top level directories in the $VIDEOfolder.
fs:scope-video-index	This scope permits to list all files and folders in the $VIDEOfolder.
fs:deny-webview-data-linux	This denies read access to the $APPLOCALDATA folder on linux as the webview data and configuration values are stored here. Allowing access can lead to sensitive information disclosure and should be well considered.
fs:deny-webview-data-windows	This denies read access to the $APPLOCALDATA/EBWebView folder on windows as the webview data and configuration values are stored here. Allowing access can lead to sensitive information disclosure and should be well considered.

Command Permissions

Permission	Description
fs:allow-copy-file	Enables the copy_file command without any pre-configured scope.
fs:deny-copy-file	Denies the copy_file command without any pre-configured scope.
fs:allow-create	Enables the create command without any pre-configured scope.
fs:deny-create	Denies the create command without any pre-configured scope.
fs:allow-exists	Enables the exists command without any pre-configured scope.
fs:deny-exists	Denies the exists command without any pre-configured scope.
fs:allow-fstat	Enables the fstat command without any pre-configured scope.
fs:deny-fstat	Denies the fstat command without any pre-configured scope.
fs:allow-ftruncate	Enables the ftruncate command without any pre-configured scope.
fs:deny-ftruncate	Denies the ftruncate command without any pre-configured scope.
fs:allow-lstat	Enables the lstat command without any pre-configured scope.
fs:deny-lstat	Denies the lstat command without any pre-configured scope.
fs:allow-mkdir	Enables the mkdir command without any pre-configured scope.
fs:deny-mkdir	Denies the mkdir command without any pre-configured scope.
fs:allow-open	Enables the open command without any pre-configured scope.
fs:deny-open	Denies the open command without any pre-configured scope.
fs:allow-read	Enables the read command without any pre-configured scope.
fs:deny-read	Denies the read command without any pre-configured scope.
fs:allow-read-dir	Enables the read_dir command without any pre-configured scope.
fs:deny-read-dir	Denies the read_dir command without any pre-configured scope.
fs:allow-read-file	Enables the read_file command without any pre-configured scope.
fs:deny-read-file	Denies the read_file command without any pre-configured scope.
fs:allow-read-text-file	Enables the read_text_file command without any pre-configured scope.
fs:deny-read-text-file	Denies the read_text_file command without any pre-configured scope.
fs:allow-read-text-file-lines	Enables the read_text_file_lines command without any pre-configured scope.
fs:deny-read-text-file-lines	Denies the read_text_file_lines command without any pre-configured scope.
fs:allow-read-text-file-lines-next	Enables the read_text_file_lines_next command without any pre-configured scope.
fs:deny-read-text-file-lines-next	Denies the read_text_file_lines_next command without any pre-configured scope.
fs:allow-remove	Enables the remove command without any pre-configured scope.
fs:deny-remove	Denies the remove command without any pre-configured scope.
fs:allow-rename	Enables the rename command without any pre-configured scope.
fs:deny-rename	Denies the rename command without any pre-configured scope.
fs:allow-seek	Enables the seek command without any pre-configured scope.
fs:deny-seek	Denies the seek command without any pre-configured scope.
fs:allow-stat	Enables the stat command without any pre-configured scope.
fs:deny-stat	Denies the stat command without any pre-configured scope.
fs:allow-truncate	Enables the truncate command without any pre-configured scope.
fs:deny-truncate	Denies the truncate command without any pre-configured scope.
fs:allow-unwatch	Enables the unwatch command without any pre-configured scope.
fs:deny-unwatch	Denies the unwatch command without any pre-configured scope.
fs:allow-watch	Enables the watch command without any pre-configured scope.
fs:deny-watch	Denies the watch command without any pre-configured scope.
fs:allow-write	Enables the write command without any pre-configured scope.
fs:deny-write	Denies the write command without any pre-configured scope.
fs:allow-write-file	Enables the write_file command without any pre-configured scope.
fs:deny-write-file	Denies the write_file command without any pre-configured scope.
fs:allow-write-text-file	Enables the write_text_file command without any pre-configured scope.
fs:deny-write-text-file	Denies the write_text_file command without any pre-configured scope.
fs:read-all	This enables all read related commands without any pre-configured accessible paths.
fs:read-dirs	This enables directory read and file metadata related commands without any pre-configured accessible paths.
fs:read-files	This enables file read related commands without any pre-configured accessible paths.
fs:read-meta	This enables all index or metadata related commands without any pre-configured accessible paths.
fs:scope	An empty permission you can use to modify the global scope.
fs:write-all	This enables all write related commands without any pre-configured accessible paths.
fs:write-files	This enables all file write related commands without any pre-configured accessible paths.

Scopes

To allow any fs command to access specific scopes:

src-tauri/capabilities/main.json

{
  "$schema": "../gen/schemas/desktop-schema.json",
  "identifier": "main-capability",
  "description": "Capability for the main window",
  "windows": ["main"],
  "permissions": [
    {
      "identifier": "fs:scope",
      "allow": [{ "path": "$APPDATA" }, { "path": "$APPDATA/**" }]
    }
  ]
}

To allow specific fs command to access specific scopes:

src-tauri/capabilities/main.json

{
  "$schema": "../gen/schemas/desktop-schema.json",
  "identifier": "main-capability",
  "description": "Capability for the main window",
  "windows": ["main"],
  "permissions": [
    {
      "identifier": "fs:allow-rename",
      "allow": [{ "path": "$HOME/**" }]
    },
    {
      "identifier": "fs:allow-exists",
      "allow": [{ "path": "$APPDATA/*" }]
    }
  ]
}