Configuration

The tauri.conf.json is a file generated by the tauri init command (see here) that lives in your Tauri application source directory (src-tauri).

Once generated, you may modify it at will to customize your Tauri application.

It's composed of the following properties:

build

distDir: string

The path—either absolute or relative—to the production-ready webpage/webapp directory that will be bundled by Tauri.

The target directory must contain an index.html file.

devPath: string

Can be a path—either absolute or relative—to a folder or a URL (like a live reload server).

beforeDevCommand?: string

A command to run before starting Tauri in dev mode.

beforeBuildCommand?: string

A command to run before starting Tauri in build mode.

withGlobalTauri?: boolean

Enables the API injection to the window.__TAURI__ object. Useful if you're using Vanilla JS instead of importing the API using Rollup or Webpack.

Example

"build": {
  "distDir": "../dist",
  "devPath": "http://localhost:4000",
  "beforeDevCommand": "npm run dev",
  "beforeBuildCommand": "npm run build",
  "withGlobalTauri": false
}

ctx

debug?: boolean

Tells the CLI to build on debug mode instead of release. Can also be used as tauri build --debug.

exitOnPanic?: boolean

Whether or not the webview should be killed if some Rust code error happened. Can also be used as tauri dev --exit-on-panic or tauri dev -e.

Example

"ctx" {
  "debug": false,
  "exitOnPanic": false,
}

tauri

cli?: CliConfig

args?: CliArg[]

CliArg

short?: string

the short version of the argument, without the preceding hyphen (the "-" character).

Any leading hyphen will be stripped, and only the first non hyphen character will be used as the short version.

name: string

The unique argument name.

description?: string

The argument description which will be shown on the help information. Typically, this is a short (one line) description of the arg.

longDescription?: string

The argument long description which will be shown on the help information. Typically, this a more detailed (multi-line) message that describes the argument

takesValue?: boolean

Specifies that the argument takes a value at runtime.

Values for arguments may be specified in any of the following methods:

• Using a space such as -o value or --option value
• Using an equals and no space such as -o=value or --option=value
• Use a short and no space such as -ovalue

index?: number

The positional argument index, starting at 1.

The index refers to position according to other positional argument. It does not define position in the argument list as a whole. When utilized with multiple=true, only the last positional argument may be defined as multiple (i.e. the one with the highest index).

multiple?: boolean

Specifies that the argument may appear more than once. For flags, this results in the number of occurrences of the flag being recorded. For example -ddd or -d -d -d would count as three occurrences. For options, there is a distinct difference in multiple occurrences vs multiple values. For example, --opt val1 val2 is one occurrence, but two values. Whereas --opt val1 --opt val2 is two occurrences.

possibleValues?: string[]

Specifies a list of possible values for this argument. At runtime, the CLI verifies that only one of the specified values was used, or fails with an error message.

minValues?: number

Specifies the minimum number of values for this argument. For example, if you had a -f <file> argument where you wanted at least 2 "files" you would set minValues: 2, and this argument would be satisfied if the user provided, 2 or more values.

maxValues?: number

Specifies the maximum number of values for this argument. For example, if you had a -f <file> argument where you wanted up to 3 "files" you would set max_values: 3, and this argument would be satisfied if the user provided, 1, 2, or 3 values.

required?: boolean

Sets whether or not the argument is required by default. "required by default" means it is required, when no other conflicting rules have been evaluated conflicting rules take precedence over being required.

requiredUnless?: string

Sets an arg that overrides this arg's required setting.
i.e. this arg will be required unless this other argument is present.

requiredUnlessAll?: string[]

Sets args that override this arg's required setting.
i.e. this arg will be required unless all these other arguments are present.

requiredUnlessOne?: string[]

Sets args that override this arg's required setting.
i.e. this arg will be required unless at least one of these other arguments are present.

conflictsWith?: string

Sets a conflicting argument by name i.e. when using this argument, the following argument can't be present and vice versa.

conflictsWithAll?: string

The same as "conflictsWith" but allows specifying multiple two-way conflicts per argument.

requires?: string

Sets an argument by name that is required when this one is present.
i.e. when using this argument, the following argument must be present.

requiresAll?: string[]

Sets multiple arguments by names that are required when this one is present.
i.e. when using this argument, the following arguments must be present.

requiresIf?: [string, string]

Allows a conditional requirement with the signature [arg: string, value: string].

The requirement will only become valid if "arg"'s value equals ${value}.

requiredIf?: [string, string]

Allows specifying that an argument is required conditionally with the signature [arg: string, value: string].

The requirement will only become valid if the "arg"'s value equals ${value}.

requireEquals?: boolean

Requires that options use the --option=val syntax.
i.e. an equals between the option and associated value.

description?: string

Command description which will be shown on the help information.

longDescription?: string

Command long description which will be shown on the help information.

beforeHelp?: string

Adds additional help information to be displayed in addition to auto-generated help.
This information is displayed before the auto-generated help information.
This is often used for header information.

afterHelp?: string

Adds additional help information to be displayed in addition to auto-generated help.
This information is displayed after the auto-generated help information.
This is often used to describe how to use the arguments, or caveats to be noted.

subcommands?: { [name: string]: CliConfig }

List of subcommands of this command.
Subcommands are effectively sub-apps, because they can contain their own arguments, subcommands, usage, etc.
They also function just like the app command, in that they get their own auto generated help and usage.

embeddedServer: object

active?: boolean

Set it to false if you plan to serve your application statically.

bundle: object

active?: boolean

Whether we should build your app with tauri-bundler or plain cargo build.

targets?: string | string[]

An array of the bundles you want to generate; e.g. ["deb", "osx", "msi", "appimage", "dmg"] or the string 'all' to make every supported bundle. By default we bundle everything your target supports (osx/dmg on mac, deb/appimage on linux, msi on windows).

identifier: string

A string that uniquely identifies your application, in reverse-DNS form (for example, "com.example.appname" or "io.github.username.project"). For OS X and iOS, this is used as the bundle's CFBundleIdentifier value; for Windows, this is hashed to create an application GUID.

icon?: string[]

A list of (relative to src-tauri) icon paths to use for your application bundle.

resources?: string[]

A list of files or directories which will be copied to the resources section of the bundle. Globs are supported.

externalBin?: string[]

A list of—either absolute or relative—paths to binaries to embed with your application.

Note that Tauri will look for system-specific binaries following the pattern "binary-name{-target-triple}{.system-extension}".
E.g. you typed "my-binary":

• "my-binary-x86_64-pc-windows-msvc.exe" for Windows
• "my-binary-x86_64-apple-darwin" for macOS
• "my-binary-x86_64-unknown-linux-gnu" for Linux

so don't forget to provide binaries for all targeted platforms.

copyright?: string

A copyright string associated with your application.

category?: string

What kind of application this is. Should be one among the following list:
Business, DeveloperTool, Education, Entertainment, Finance, Game, ActionGame, AdventureGame, ArcadeGame, BoardGame, CardGame, CasinoGame, DiceGame, EducationalGame, FamilyGame, KidsGame, MusicGame, PuzzleGame, RacingGame, RolePlayingGame, SimulationGame, SportsGame, StrategyGame, TriviaGame, WordGame, GraphicsAndDesign, HealthcareAndFitness, Lifestyle, Medical, Music, News, Photography, Productivity, Reference, SocialNetworking, Sports, Travel, Utility, Video, Weather.

shortDescription?: string

A short description of your application.

longDescription?: string

A longer, multi-line description of the application.

deb?: object

depends?: string[]

The list of deb dependencies your application relies on.

useBootstrapper?: boolean

Enable the boostrapper script.

osx?: object

frameworks?: string[]

A list of strings indicating any macOS X frameworks that need to be bundled with the application. If a name is used, ".framework" must be omitted and it will look for standard install locations. You may also use a path to a specific framework.

minimumSystemVersion?: string

A version string indicating the minimum macOS X version that the bundled application supports.

license?: string

The path to the license file to add to the DMG.

useBootstrapper?: boolean

Enable the boostrapper script.

exceptionDomain?: string

Allows your application to communicate with the outside world.

It should be a lowercase, without port and protocol domain name.

allowlist: object

all: boolean

Use this flag to enable all API features.

createDir?: boolean

Copy file from local filesystem.

copyFile?: boolean

Create directory from local filesystem.

event?: boolean

Enable listening to messages from webview.

execute?: boolean

Enable binary execution.

listFiles?: boolean

Get a list of files in a directory.

notification?: boolean

Enable system notifications.

open?: boolean

Open link in the user's default browser.

openDialog?: boolean

Open dialog window to pick files.

readBinaryFile?: boolean

Read binary file from local filesystem.

readDir?: boolean

Read directory from local filesystem.

readTextFile?: boolean

Read text file from local filesystem.

removeDir?: boolean

Remove directory from local filesystem.

removeFile?: boolean

Remove file from local filesystem.

renameFile?: boolean

Rename file from local filesystem.

saveDialog?: boolean

Open dialog window to pick where to save files.

setTitle?: boolean

Set the webview window title.

updater?: boolean

Update the application.

writeFile?: boolean

Write file to local filesystem.

window: object

title: string

Initial window title.

width?: number

Initial window width.

height?: number

Initial window height.

resizable?: boolean

Enable window resizing.

fullscreen?: boolean

Set window as fullscreen.

security: object

csp?: string

The Content Security Policy.

This is a really important part of the configuration since it helps you ensure your webview is secured. See more on Mozilla.

inliner: object

active?: boolean

Enable the inliner. See more on our GitHub.

bootstrapper script

Instead of launching the app directly, we configure the bundled app to run a script that tries to expose the environment variables to the app; without that you'll have trouble using system CLI apps like Node.js.

Example

"tauri": {
  "cli": {
    "description": "Tauri communication example",
    "longDescription": null,
    "beforeHelp": null,
    "afterHelp": null,
    "args": [{
      "short": "c",
      "name": "config",
      "takesValue": true,
      "description": "Config path"
    }, {
      "short": "t",
      "name": "theme",
      "takesValue": true,
      "description": "App theme",
      "possibleValues": ["light", "dark", "system"]
    }, {
      "short": "v",
      "name": "verbose",
      "multipleOccurrences": true,
      "description": "Verbosity level"
    }],
    "subcommands": {
      "update": {
        "description": "Updates the app",
        "longDescription": null,
        "beforeHelp": null,
        "afterHelp": null,
        "args": [{
          "short": "b",
          "name": "background",
          "description": "Update in background"
        }],
        "subcommands": null
      }
    }
  },
  "embeddedServer": {
    "active": true
  },
  "bundle": {
    "active": true,
    "targets": ["deb"],
    "identifier": "com.tauri.dev",
    "icon": ["icons/32x32.png", "icons/128x128.png", "icons/128x128@2x.png", "icons/icon.icns", "icons/icon.ico"],
    "resources": [],
    "externalBin": [],
    "copyright": "",
    "category": "DeveloperTool",
    "shortDescription": "",
    "longDescription": "",
    "deb": {
      "depends": []
    },
    "osx": {
      "frameworks": [],
      "minimumSystemVersion": ""
    },
    "exceptionDomain": ""
  },
  "allowlist": {
    "all": true
  },
  "window": {
    "title": "Tauri App",
    "width": 800,
    "height": 600,
    "resizable": true,
    "fullscreen": false
  },
  "security": {
    "csp": "default-src blob: data: filesystem: ws: http: https: 'unsafe-eval' 'unsafe-inline'"
  },
  "inliner": {
    "active": true
  }
}