path

The path module provides utilities for working with file and directory paths.

This package is also accessible with window.__TAURI__.path when app.withGlobalTauri in tauri.conf.json is set to true.

It is recommended to allowlist only the APIs you use for optimal bundle size and security.

Platform-specific

• Android: The user directories are sandboxed per app. desktopDir, executableDir, fontDir, runtimeDir and templateDir — and the matching BaseDirectory variants — do not exist on Android at all. The remaining ones resolve inside the app’s own storage, so they are not shared with other apps, and videoDir resolves to the app-specific Movies directory.
• iOS: Every directory resolves inside the app sandbox, so paths are private to your app and change between installs. Resolve them at runtime instead of persisting absolute paths.

Remarks

All commands used by this module are part of the core:path:default permission set, which is enabled by default, so no extra capability configuration is needed.

Enumerations

BaseDirectory

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L35

Since

2.0.0

Enumeration Members

AppCache

AppCache: 16;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L104

See

appCacheDir for more information.

AppConfig

AppConfig: 13;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L92

See

appConfigDir for more information.

AppData

AppData: 14;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L96

See

appDataDir for more information.

AppLocalData

AppLocalData: 15;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L100

See

appLocalDataDir for more information.

AppLog

AppLog: 17;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L108

See

appLogDir for more information.

Audio

Audio: 1;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L39

See

audioDir for more information.

Cache

Cache: 2;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L43

See

cacheDir for more information.

Config

Config: 3;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L47

See

configDir for more information.

Data

Data: 4;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L51

See

dataDir for more information.

Desktop

Desktop: 18;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L116

See

desktopDir for more information.

Platform-specific

• Android: Unsupported, this variant does not exist on Android.

Document

Document: 6;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L59

See

documentDir for more information.

Download

Download: 7;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L63

See

downloadDir for more information.

Executable

Executable: 19;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L124

See

executableDir for more information.

Platform-specific

• Android: Unsupported, this variant does not exist on Android.

Font

Font: 20;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L132

See

fontDir for more information.

Platform-specific

• Android: Unsupported, this variant does not exist on Android.

Home

Home: 21;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L136

See

homeDir for more information.

LocalData

LocalData: 5;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L55

See

localDataDir for more information.

Picture

Picture: 8;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L67

See

pictureDir for more information.

Public

Public: 9;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L71

See

publicDir for more information.

Resource

Resource: 11;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L84

See

resourceDir for more information.

Runtime

Runtime: 22;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L144

See

runtimeDir for more information.

Platform-specific

• Android: Unsupported, this variant does not exist on Android.

Temp

Temp: 12;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L88

See

tempDir for more information.

Template

Template: 23;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L152

See

templateDir for more information.

Platform-specific

• Android: Unsupported, this variant does not exist on Android.

Video

Video: 10;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L80

See

videoDir for more information.

Platform-specific

• Android: Resolves to the app-specific Movies directory since 2.12.0, see videoDir.

Functions

appCacheDir()

function appCacheDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L217

Returns the path to the suggested directory for your app’s cache files. Resolves to ${cacheDir}/${bundleIdentifier}, where bundleIdentifier is the identifier value configured in tauri.conf.json.

Returns

Promise<string>

Example

import { appCacheDir } from '@tauri-apps/api/path';
const appCacheDirPath = await appCacheDir();

Since

1.2.0

---

appConfigDir()

function appConfigDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L166

Returns the path to the suggested directory for your app’s config files. Resolves to ${configDir}/${bundleIdentifier}, where bundleIdentifier is the identifier value configured in tauri.conf.json.

Returns

Promise<string>

Example

import { appConfigDir } from '@tauri-apps/api/path';
const appConfigDirPath = await appConfigDir();

Since

1.2.0

---

appDataDir()

function appDataDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L183

Returns the path to the suggested directory for your app’s data files. Resolves to ${dataDir}/${bundleIdentifier}, where bundleIdentifier is the identifier value configured in tauri.conf.json.

Returns

Promise<string>

Example

import { appDataDir } from '@tauri-apps/api/path';
const appDataDirPath = await appDataDir();

Since

1.2.0

---

appLocalDataDir()

function appLocalDataDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L200

Returns the path to the suggested directory for your app’s local data files. Resolves to ${localDataDir}/${bundleIdentifier}, where bundleIdentifier is the identifier value configured in tauri.conf.json.

Returns

Promise<string>

Example

import { appLocalDataDir } from '@tauri-apps/api/path';
const appLocalDataDirPath = await appLocalDataDir();

Since

1.2.0

---

appLogDir()

function appLogDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L670

Returns the path to the suggested directory for your app’s log files.

Platform-specific

• Linux: Resolves to ${configDir}/${bundleIdentifier}/logs.
• macOS: Resolves to ${homeDir}/Library/Logs/{bundleIdentifier}
• Windows: Resolves to ${configDir}/${bundleIdentifier}/logs.

Returns

Promise<string>

Example

import { appLogDir } from '@tauri-apps/api/path';
const appLogDirPath = await appLogDir();

Since

1.2.0

---

audioDir()

function audioDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L239

Returns the path to the user’s audio directory.

Platform-specific

• Linux: Resolves to xdg-user-dirs’ XDG_MUSIC_DIR.
• macOS: Resolves to $HOME/Music.
• Windows: Resolves to {FOLDERID_Music}.

Returns

Promise<string>

Example

import { audioDir } from '@tauri-apps/api/path';
const audioDirPath = await audioDir();

Since

1.0.0

---

basename()

function basename(path, ext?): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L800

Returns the last portion of a path. Trailing directory separators are ignored.

Parameters

Parameter	Type	Description
path	string	-
ext?	string	An optional file extension to be removed from the returned path.

Returns

Promise<string>

Example

import { basename } from '@tauri-apps/api/path';
const base = await basename('path/to/app.conf');
assert(base === 'app.conf');

Since

1.0.0

---

cacheDir()

function cacheDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L261

Returns the path to the user’s cache directory.

Platform-specific

• Linux: Resolves to $XDG_CACHE_HOME or $HOME/.cache.
• macOS: Resolves to $HOME/Library/Caches.
• Windows: Resolves to {FOLDERID_LocalAppData}.

Returns

Promise<string>

Example

import { cacheDir } from '@tauri-apps/api/path';
const cacheDirPath = await cacheDir();

Since

1.0.0

---

configDir()

function configDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L283

Returns the path to the user’s config directory.

Platform-specific

• Linux: Resolves to $XDG_CONFIG_HOME or $HOME/.config.
• macOS: Resolves to $HOME/Library/Application Support.
• Windows: Resolves to {FOLDERID_RoamingAppData}.

Returns

Promise<string>

Example

import { configDir } from '@tauri-apps/api/path';
const configDirPath = await configDir();

Since

1.0.0

---

dataDir()

function dataDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L305

Returns the path to the user’s data directory.

Platform-specific

• Linux: Resolves to $XDG_DATA_HOME or $HOME/.local/share.
• macOS: Resolves to $HOME/Library/Application Support.
• Windows: Resolves to {FOLDERID_RoamingAppData}.

Returns

Promise<string>

Example

import { dataDir } from '@tauri-apps/api/path';
const dataDirPath = await dataDir();

Since

1.0.0

---

delimiter()

function delimiter(): string;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L710

Returns the platform-specific path segment delimiter:

• ; on Windows
• : on POSIX

Returns

string

Since

2.0.0

---

desktopDir()

function desktopDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L330

Returns the path to the user’s desktop directory.

Platform-specific

• Android: Unsupported. Android has no desktop directory, the BaseDirectory.Desktop variant does not exist there and the call rejects.

• Linux: Resolves to xdg-user-dirs’ XDG_DESKTOP_DIR.

• macOS: Resolves to $HOME/Desktop.

• Windows: Resolves to {FOLDERID_Desktop}.

Returns

Promise<string>

Example

import { desktopDir } from '@tauri-apps/api/path';
const desktopPath = await desktopDir();

Since

1.0.0

---

dirname()

function dirname(path): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L769

Returns the parent directory of a given path. Trailing directory separators are ignored.

Parameters

Parameter	Type
path	string

Returns

Promise<string>

Example

import { dirname } from '@tauri-apps/api/path';
const dir = await dirname('/path/to/somedir/');
assert(dir === '/path/to');

Since

1.0.0

---

documentDir()

function documentDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L352

Returns the path to the user’s document directory.

Returns

Promise<string>

Example

import { documentDir } from '@tauri-apps/api/path';
const documentDirPath = await documentDir();

Platform-specific

• Linux: Resolves to xdg-user-dirs’ XDG_DOCUMENTS_DIR.
• macOS: Resolves to $HOME/Documents.
• Windows: Resolves to {FOLDERID_Documents}.

Since

1.0.0

---

downloadDir()

function downloadDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L374

Returns the path to the user’s download directory.

Platform-specific

• Linux: Resolves to xdg-user-dirs’ XDG_DOWNLOAD_DIR.
• macOS: Resolves to $HOME/Downloads.
• Windows: Resolves to {FOLDERID_Downloads}.

Returns

Promise<string>

Example

import { downloadDir } from '@tauri-apps/api/path';
const downloadDirPath = await downloadDir();

Since

1.0.0

---

executableDir()

function executableDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L399

Returns the path to the user’s executable directory.

Platform-specific

• Android: Unsupported. The BaseDirectory.Executable variant does not exist there and the call rejects.

• Linux: Resolves to $XDG_BIN_HOME/../bin or $XDG_DATA_HOME/../bin or $HOME/.local/bin.

• macOS: Not supported.

• Windows: Not supported.

Returns

Promise<string>

Example

import { executableDir } from '@tauri-apps/api/path';
const executableDirPath = await executableDir();

Since

1.0.0

---

extname()

function extname(path): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L784

Returns the extension of the path.

Parameters

Parameter	Type
path	string

Returns

Promise<string>

Example

import { extname } from '@tauri-apps/api/path';
const ext = await extname('/path/to/file.html');
assert(ext === 'html');

Since

1.0.0

---

fontDir()

function fontDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L424

Returns the path to the user’s font directory.

Platform-specific

• Android: Unsupported. The BaseDirectory.Font variant does not exist there and the call rejects.

• Linux: Resolves to $XDG_DATA_HOME/fonts or $HOME/.local/share/fonts.

• macOS: Resolves to $HOME/Library/Fonts.

• Windows: Not supported.

Returns

Promise<string>

Example

import { fontDir } from '@tauri-apps/api/path';
const fontDirPath = await fontDir();

Since

1.0.0

---

homeDir()

function homeDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L446

Returns the path to the user’s home directory.

Platform-specific

• Linux: Resolves to $HOME.
• macOS: Resolves to $HOME.
• Windows: Resolves to {FOLDERID_Profile}.

Returns

Promise<string>

Example

import { homeDir } from '@tauri-apps/api/path';
const homeDirPath = await homeDir();

Since

1.0.0

---

isAbsolute()

function isAbsolute(path): Promise<boolean>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L814

Returns whether the path is absolute or not.

Parameters

Parameter	Type
path	string

Returns

Promise<boolean>

Example

import { isAbsolute } from '@tauri-apps/api/path';
assert(await isAbsolute('/home/tauri'));

Since

1.0.0

---

join()

function join(...paths): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L754

Joins all given path segments together using the platform-specific separator as a delimiter, then normalizes the resulting path.

Parameters

Parameter	Type
…paths	string[]

Returns

Promise<string>

Example

import { join, appDataDir } from '@tauri-apps/api/path';
const appDataDirPath = await appDataDir();
const path = await join(appDataDirPath, 'users', 'tauri', 'avatar.png');

Since

1.0.0

---

localDataDir()

function localDataDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L468

Returns the path to the user’s local data directory.

Platform-specific

• Linux: Resolves to $XDG_DATA_HOME or $HOME/.local/share.
• macOS: Resolves to $HOME/Library/Application Support.
• Windows: Resolves to {FOLDERID_LocalAppData}.

Returns

Promise<string>

Example

import { localDataDir } from '@tauri-apps/api/path';
const localDataDirPath = await localDataDir();

Since

1.0.0

---

normalize()

function normalize(path): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L739

Normalizes the given path, resolving '..' and '.' segments and resolve symbolic links.

Parameters

Parameter	Type
path	string

Returns

Promise<string>

Example

import { normalize, appDataDir } from '@tauri-apps/api/path';
const appDataDirPath = await appDataDir();
const path = await normalize(`${appDataDirPath}/../users/tauri/avatar.png`);

Since

1.0.0

---

pictureDir()

function pictureDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L490

Returns the path to the user’s picture directory.

Platform-specific

• Linux: Resolves to xdg-user-dirs’ XDG_PICTURES_DIR.
• macOS: Resolves to $HOME/Pictures.
• Windows: Resolves to {FOLDERID_Pictures}.

Returns

Promise<string>

Example

import { pictureDir } from '@tauri-apps/api/path';
const pictureDirPath = await pictureDir();

Since

1.0.0

---

publicDir()

function publicDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L512

Returns the path to the user’s public directory.

Platform-specific

• Linux: Resolves to xdg-user-dirs’ XDG_PUBLICSHARE_DIR.
• macOS: Resolves to $HOME/Public.
• Windows: Resolves to {FOLDERID_Public}.

Returns

Promise<string>

Example

import { publicDir } from '@tauri-apps/api/path';
const publicDirPath = await publicDir();

Since

1.0.0

---

resolve()

function resolve(...paths): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L724

Resolves a sequence of paths or path segments into an absolute path.

Parameters

Parameter	Type
…paths	string[]

Returns

Promise<string>

Example

import { resolve, appDataDir } from '@tauri-apps/api/path';
const appDataDirPath = await appDataDir();
const path = await resolve(appDataDirPath, '..', 'users', 'tauri', 'avatar.png');

Since

1.0.0

---

resolveResource()

function resolveResource(resourcePath): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L565

Resolve the path to a resource file.

Parameters

Parameter	Type	Description
resourcePath	string	The path to the resource. Must follow the same syntax as defined in tauri.conf.json > bundle > resources, i.e. keeping subfolders and parent dir components (../).

Returns

Promise<string>

The full path to the resource.

Example

import { resolveResource } from '@tauri-apps/api/path';
const resourcePath = await resolveResource('script.sh');

Since

1.0.0

---

resourceDir()

function resourceDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L545

Returns the path to the application’s resource directory. To resolve a resource path, see resolveResource.

Platform-specific

Although we provide the exact path where this function resolves to, this is not a contract and things might change in the future

• Windows: Resolves to the directory that contains the main executable.
• Linux: When running in an AppImage, the APPDIR variable will be set to the mounted location of the app, and the resource dir will be ${APPDIR}/usr/lib/${exe_name}. If not running in an AppImage, the path is /usr/lib/${exe_name}. When running the app from src-tauri/target/(debug|release)/, the path is ${exe_dir}/../lib/${exe_name}.
• macOS: Resolves to ${exe_dir}/../Resources (inside .app).
• iOS: Resolves to ${exe_dir}/assets.
• Android: Currently the resources are stored in the APK as assets so it’s not a normal file system path, we return a special URI prefix asset://localhost/ here that can be used with the file system plugin,

Returns

Promise<string>

Example

import { resourceDir } from '@tauri-apps/api/path';
const resourceDirPath = await resourceDir();

Since

1.0.0

---

runtimeDir()

function runtimeDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L591

Returns the path to the user’s runtime directory.

Platform-specific

• Android: Unsupported. The BaseDirectory.Runtime variant does not exist there and the call rejects.

• Linux: Resolves to $XDG_RUNTIME_DIR.

• macOS: Not supported.

• Windows: Not supported.

Returns

Promise<string>

Example

import { runtimeDir } from '@tauri-apps/api/path';
const runtimeDirPath = await runtimeDir();

Since

1.0.0

---

sep()

function sep(): string;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L699

Returns the platform-specific path segment separator:

• \ on Windows
• / on POSIX

Returns

string

Since

2.0.0

---

tempDir()

function tempDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L686

Returns a temporary directory.

Returns

Promise<string>

Example

import { tempDir } from '@tauri-apps/api/path';
const temp = await tempDir();

Since

2.0.0

---

templateDir()

function templateDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L616

Returns the path to the user’s template directory.

Platform-specific

• Android: Unsupported. The BaseDirectory.Template variant does not exist there and the call rejects.

• Linux: Resolves to xdg-user-dirs’ XDG_TEMPLATES_DIR.

• macOS: Not supported.

• Windows: Resolves to {FOLDERID_Templates}.

Returns

Promise<string>

Example

import { templateDir } from '@tauri-apps/api/path';
const templateDirPath = await templateDir();

Since

1.0.0

---

videoDir()

function videoDir(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L648

Returns the path to the user’s video directory.

Platform-specific

• Linux: Resolves to xdg-user-dirs’ XDG_VIDEOS_DIR.
• macOS: Resolves to $HOME/Movies.
• Windows: Resolves to {FOLDERID_Videos}.
• Android: Resolves to the app-specific Movies directory (getExternalFilesDir(DIRECTORY_MOVIES)), typically .../files/Movies. It is private to your app and removed when the app is uninstalled.
• iOS: Resolves inside the app sandbox.

Returns

Promise<string>

Example

import { videoDir } from '@tauri-apps/api/path';
const videoDirPath = await videoDir();

Remarks

Breaking change on Android in tauri 2.12.0: videoDir() and the $VIDEO path variable used to resolve to external cache storage (.../cache) and now resolve to the app-specific Movies directory (.../files/Movies). Files written to the old location are not found at the new one, so migrate them or update your path assumptions.

Since

1.0.0