App Size

import { Tabs, TabItem } from '@astrojs/starlight/components';

While Tauri by default provides very small binaries it doesn't hurt to push the limits a bit, so here are some tips and tricks for reaching optimal results.

Cargo Configuration

One of the simplest frontend agnostic size improvements you can do to your project is adding a Cargo profile to it.

Dependent on whether you use the stable or nightly Rust toolchain the options available to you differ a bit. It's recommended you stick to the stable toolchain unless you're an advanced user.

# src-tauri/Cargo.toml
[profile.dev]
incremental = true # Compile your binary in smaller steps.

[profile.release]
codegen-units = 1 # Allows LLVM to perform better optimization.
lto = true # Enables link-time-optimizations.
opt-level = "s" # Prioritizes small binary size. Use `3` if you prefer speed.
panic = "abort" # Higher performance by disabling panic handlers.
strip = true # Ensures debug symbols are removed.

# src-tauri/Cargo.toml
[profile.dev]
incremental = true # Compile your binary in smaller steps.
rustflags = ["-Zthreads=8"] # Better compile performance.

[profile.release]
codegen-units = 1 # Allows LLVM to perform better optimization.
lto = true # Enables link-time-optimizations.
opt-level = "s" # Prioritizes small binary size. Use `3` if you prefer speed.
panic = "abort" # Higher performance by disabling panic handlers.
strip = true # Ensures debug symbols are removed.
trim-paths = "all" # Removes potentially privileged information from your binaries.
rustflags = ["-Cdebuginfo=0", "-Zthreads=8"] # Better compile performance.

References

:::note This is not a complete reference over all available options, merely the ones that we'd like to draw extra attention to. :::

• incremental: Compile your binary in smaller steps.
• codegen-units: Speeds up compile times at the cost of compile time optimizations.
• lto: Enables link time optimizations.
• opt-level: Determines the focus of the compiler. Use 3 to optimize performance, z to optimize for size, and s for something in-between.
• panic: Reduce size by removing panic unwinding.
• strip: Strip either symbols or debuginfo from a binary.
• rpath: Assists in finding the dynamic libraries the binary requires by hard coding information into the binary.
• trim-paths: Removes potentially privileged information from binaries.
• rustflags: Sets Rust compiler flags on a profile by profile basis.
  • -Cdebuginfo=0: Whether debuginfo symbols should be included in the build.
  • -Zthreads=8: Increases the number of threads used during compilation.

Remove Unused Commands

In Pull Request feat: add a new option to remove unused commands, we added in a new option in the tauri config file

{
  "build": {
    "removeUnusedCommands": true
  }
}

to remove commands that're never allowed in your capability files (ACL), so you don't have to pay for what you don't use

:::tip To maximize the benefit of this, only include commands that you use in the ACL instead of using defaultss :::

:::note This feature requires [email protected], [email protected], [email protected] and [email protected] :::

:::note This won't be accounting for dynamically added ACLs at runtime so make sure to check it when using this :::

tauri-cli will communicate with tauri-build and the build script of tauri, tauri-plugin through an environment variable and let them generate a list of allowed commands from the ACL, this will then be used by the generate_handler macro to remove unused commands based on that

An internal detail is this environment variable is currently REMOVE_UNUSED_COMMANDS, and it's set to project's directory, usually the src-tauri directory, this is used for the build scripts to find the capability files, and although it's not encouraged, you can still set this environment variable yourself if you can't or don't want to use tauri-cli to get this to work (do note that as this is an implementation detail, we don't guarantee the stability of it)