tauri-workspace/packages/cli

@tauri-apps/cli

Component	Version
@tauri-apps/cli

About Tauri

Tauri is a polyglot and generic system that is very composable and allows engineers to make a wide variety of applications. It is used for building applications for Desktop Computers using a combination of Rust tools and HTML rendered in a Webview. Apps built with Tauri can ship with any number of pieces of an optional JS API / Rust API so that webviews can control the system via message passing. In fact, developers can extend the default API with their own functionality and bridge the Webview and Rust-based backend easily.

Tauri apps can have custom menus and have tray-type interfaces. They can be updated, and are managed by the user's operating system as expected. They are very small, because they use the system's webview. They do not ship a runtime, since the final binary is compiled from rust. This makes the reversing of Tauri apps not a trivial task.

This module

Written in Typescript and packaged such that it can be used with npm, pnpm, yarn, and bun, this library provides a node.js runner for common tasks when using Tauri, like pnpm tauri dev. For the most part it is a wrapper around tauri-cli.

To learn more about the details of how all of these pieces fit together, please consult this ARCHITECTURE.md document.

Installation

The preferred method is to install this module locally as a development dependency:

$ pnpm add -D @tauri-apps/cli
$ yarn add -D @tauri-apps/cli
$ npm add -D @tauri-apps/cli

Semver

tauri is following Semantic Versioning 2.0.

Licenses

Code: (c) 2019 - 2021 - The Tauri Programme within The Commons Conservancy.

MIT or MIT/Apache 2.0 where applicable.

Logo: CC-BY-NC-ND

• Original Tauri Logo Designs by Daniel Thompson-Yvetot and Guillaume Chau