@tauri-apps/cli

What is @tauri-apps/cli?

@tauri-apps/cli is a command-line interface tool for building Tauri applications. Tauri is a framework for building tiny, fast, and secure desktop applications using web technologies like HTML, CSS, and JavaScript. The CLI provides various commands to scaffold, develop, and build Tauri applications.

What are @tauri-apps/cli's main functionalities?

Scaffold a new Tauri project

This command initializes a new Tauri project. It sets up the necessary configuration files and directory structure to start developing a Tauri application.

tauri init

Development server

This command starts a development server for the Tauri application. It allows developers to preview their application in a desktop environment and provides hot-reloading for a better development experience.

tauri dev

Build a Tauri application

This command compiles the Tauri application into a native binary for distribution. It packages the web assets and the Rust backend into a single executable.

tauri build

Other packages similar to @tauri-apps/cli

electron

Electron is a popular framework for building cross-platform desktop applications with web technologies. Like Tauri, it allows developers to use HTML, CSS, and JavaScript to create desktop apps. However, Electron applications tend to be larger in size compared to Tauri apps due to the inclusion of a full Chromium browser.

nw

NW.js (previously known as node-webkit) is another framework for building desktop applications using web technologies. It is similar to Electron and Tauri in that it allows developers to create applications with HTML, CSS, and JavaScript. NW.js provides more flexibility in terms of Node.js integration but, like Electron, can result in larger application sizes.

README

@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