github-actions[bot] d349558abb Apply Version Updates From Current Changes (#9149) 1 year ago
..
.cargo 4334865266 refactor(cli): rename `tooling/cli.rs` folder to `tooling/cli` (#3388) 3 years ago
npm 0ddbb3a1dc feat(cli): Build the CLI for Windows ARM64, closes #7015 (#7098) 2 years ago
src 4b75834a41 chore: update license headers 2024 (#9043) 1 year ago
test 4b75834a41 chore: update license headers 2024 (#9043) 1 year ago
.gitignore 715cbde384 feat(config): add `$schema` to `tauri.conf.json`, closes #3464 (#4031) 3 years ago
.npmignore 2d69dfe1dc fix(cli): package license, remove test code (#3439) 3 years ago
CHANGELOG.md d349558abb Apply Version Updates From Current Changes (#9149) 1 year ago
Cargo.toml b4ffbe7aa2 chore(deps) Update Tauri CLI (dev) (#8226) 1 year ago
LICENSE_APACHE-2.0 2d69dfe1dc fix(cli): package license, remove test code (#3439) 3 years ago
LICENSE_MIT 2d69dfe1dc fix(cli): package license, remove test code (#3439) 3 years ago
README.md e152662687 feat: support Bun package manager (#7723) 1 year ago
build.rs 4b75834a41 chore: update license headers 2024 (#9043) 1 year ago
index.d.ts 4b75834a41 chore: update license headers 2024 (#9043) 1 year ago
index.js 4b75834a41 chore: update license headers 2024 (#9043) 1 year ago
jest.config.js 4b75834a41 chore: update license headers 2024 (#9043) 1 year ago
main.d.ts 4b75834a41 chore: update license headers 2024 (#9043) 1 year ago
main.js 4b75834a41 chore: update license headers 2024 (#9043) 1 year ago
package.json d349558abb Apply Version Updates From Current Changes (#9149) 1 year ago
tauri.js 4b75834a41 chore: update license headers 2024 (#9043) 1 year ago
yarn.lock a0f7b88fd8 build(api.js): simplify output JS files (#8025) 1 year ago

README.md

@tauri-apps/cli

status License test cli FOSSA Status Chat Server website support

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 yarn 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:

$ npm install --save-dev @tauri-apps/cli
$ yarn add --dev @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