Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

tauri

tauri-apps2.3kMIT0.15.0TypeScript support: included

Multi-binding collection of libraries and templates for building Tauri apps

readme

tauri

This package represents the Tauri alpha CLI. To use the stable Tauri CLI, see @tauri-apps/cli.

changelog

Changelog

[0.15.0]

  • The package is no longer maintained since it was only used for the Tauri alpha.
    • 41d2f3ed9 feat(tauri.js): add warning on 2023-05-23

[0.14.1]

  • Fixed a TypeScript issue where it didn't allow you to put the "recursive" option in the directory functions.
    • 2fd1067 Fix: add recursive option to directory APIs (#1141) on 2021-01-12

[0.14.0]

  • Update the tauri template to properly set the app icon id on Windows so the webview can load the executable icon. To use it on old projects, update your src-tauri/src/build.rs file, replacing res.set_icon("icons/icon.ico"); with res.set_icon_with_id("icons/icon.ico", "32512");. - f887320 fix(template) default windows icon id should be 32512, fixes #1099 (#1107) on 2020-12-05
  • Fixes tauri deps command usage when npm is not installed.
    • 8da495f fix(tauri.js) deps cmd usage when npm is not installed, closes #1037 (#1053) on 2020-12-05
  • Match writeBinaryFile command name between js and rust
    • 486bd92 Fix: writeBinaryFile to call the correct command (fix #1133) (#1136) on 2021-01-06

[0.13.0]

  • Fixes Reflect.deleteProperty on promisified API calls failing with Unable to delete property by making it configurable.
    • c8b167a fix(tauri.js) promisified API fails on Reflect.deleteProperty, fix #1038 (#1056) on 2020-10-17
    • 72996be apply version updates (#1024) on 2020-10-21
  • Adds a path resolution API (e.g. getting the download directory or resolving a path to the home directory).

[0.12.0]

  • Break out TauriBuildConfig interface from TauriConfig build property
  • Create recipes. A recipe:
    • Updates the TauriBuildConfig during the init process
    • Specifies npm dev and production dependencies to be installed
    • Runs extra installation scripts
    • 43a8c4d fix #920: Create recipes (#930) on 2020-08-17
  • Create React JS and React TS recipes
  • Add new top level command create, which accepts a recipe as a CLI, or runs interactively, prompting for a recipe out of a menu of choices defined by api/recipes/index
  • Refactor init command so that it is just an alias for create with no recipe
  • Bump all deps as noted in #975, #976, #977, #978, and #979.
    • 06dd75b chore: bump all js/rust deps (#983) on 2020-08-20
  • Make interactive prompt not ask for app name supplied as cli arg
    • 59e0de7 Fix cli no prompt for app-name cli arg (#980) on 2020-08-19
  • Change String to string type for open and save methods
    • 0a5bac1 fix(tauri.js): fix typings for open and save dialogs (#926) on 2020-08-08
  • Format all code with prettier. This technically should only affect code styles, but noting for posterity.
    • 6a21965 chore: add prettier for js formatting (#937) on 2020-08-18
  • Set correct promise resolve type which returns from readBinaryFile
    • f98d4b9 fix(tauri.js): fix return type for readBinaryFile api method (#927) on 2020-08-08
  • Add types to JSDoc annotations
    • f98d4b9 fix(tauri.js): fix return type for readBinaryFile api method (#927) on 2020-08-08

[0.11.1]

  • Fix command line arguments -W (window title) and -P (dev server uri) to work as intended.
    • e1fd626 Fix typos referring to CLI args in init command (#921) on 2020-08-03

[0.11.0]

  • Fixes the Webview initialization on Windows.
    • 4abd12c fix(tauri) webview initialization on windows, fixes #879 (#885) on 2020-07-23

[0.10.0]

  • Fixes the writeFile and writeBinaryFile usage.
    • cbd14c3 fix(tauri.js) writeFile and writeBinaryFile API (#857) on 2020-07-19
  • The notification's body is now optional, closes #793.
    • dac1db3 fix(tauri) notification body optional, requestPermission() regression, closes #793 (#844) on 2020-07-16
  • Fixes a memory leak on the promisified helper usage.
    • 42a8bb0 fix(api) promisified not cleaning up transformed callbacks, fixes #852 (#853) on 2020-07-18
  • Prevent running the dev pipeline when running with administrator privileges.
    • 1780057 fix(tauri.js) exit dev when running as admin, fixes #781 (#839) on 2020-07-15
  • Print outdated dependencies information on tauri info.
    • f0ce94f feat(tauri.js) print outdated deps information on tauri info (#841) on 2020-07-15
  • Convert the --app-name value to kebab case.
    • da99f63 fix(tauri.js) app name as kebab case (#856) on 2020-07-19
  • Do not require a package.json file on the app root.
    • 45d3de6 fix(tauri.js) do not require a package.json (#855) on 2020-07-19
  • Adds a dependency manager command to the Node.js CLI (tauri deps). The manager is able to install and update Rust and the Tauri ecosystem dependencies (npm package, crates, cargo subcommands). Usage: tauri deps install and tauri deps update. - 77282c1 feat(tauri.js) add dependency manager command (#829) on 2020-07-15
  • Run the dependency manager's install script after tauri init succeeds.
    • 0591f1f feat(tauri.js) run deps install after tauri init (#842) on 2020-07-15
  • Move types exported in the tauri js api into the modules that use them. For example, Event is now available from tauri/api/event instead of tauri/api/types/event. - 660a2d8 feat(tauri.js) move exported api types into api modules (fix #807) (#809) on 2020-07-12

[0.9.1]

  • Fixes Edge blank screen on Windows when running tauri dev (Tauri crashing window due to Edge reloading app because of missing Content-Type header).
    • Bumped due to a bump in tauri-api.
    • fedee83 fix(tauri.js) windows Edge blank screen on tauri dev (#808) on 2020-07-11
  • Improve the tauri info output on Windows, including the Microsoft Edge version.
    • 0d6235e feat(tauri.js) add microsoft edge version to the info output (#810) on 2020-07-12

[0.9.0]

  • Fixes a race condition on the beforeDevCommand usage (starting Tauri before the devServer is ready).
    • a26cffc fix(tauri.js) beforeDevCommand race condition (#801) on 2020-07-10
  • Revert a nullish coalescing operator that changed embedded server/inliner behavior.
    • e7b4951 fix(tauri.js) revert nullish coalesce addition (#799) on 2020-07-10
  • Fixes tauri init not generating tauri.conf.json on the Vue CLI Plugin.
    • f208a68 fix(tauri.js) do not swallow init errors, fix conf inject (#802) on 2020-07-10
  • tauri init now prompt for default values such as window title, app name, dist dir and dev path. You can use --ci to skip the prompts.

[0.8.4]

  • Bump lodash to 4.17.19

[0.8.3]

  • Fixes the wrong cli value on the template that's used by tauri init. Also fixes the template test.
  • Fixes the tauri icon usage with the --icon flag. Previously, only the -i flag worked.

[0.8.2]

  • Adds tauri.conf.json schema validation to the CLI.

[0.8.1]

  • Transpile the TS API to ES5. Expose CJS as .js and ESM as .mjs.
  • Fixes the assets embedding into the binary.

[0.8.0]

  • Create UMD, ESM and CJS artifacts for the JavaScript API entry point from TS source using rollup.
  • Renaming window.tauri to window._TAURI\_, closing #435. The Tauri object now follows the TypeScript API structure (e.g. window.tauri.readTextFile is now window._TAURI\_.fs.readTextFile). If you want to keep the window.tauri object for a while, you can add a mapping object to your code.