Jonas Kruckenberg 19fff57191 wip 2 years ago
..
.cargo 4334865266 refactor(cli): rename `tooling/cli.rs` folder to `tooling/cli` (#3388) 3 years ago
npm f7d2dfc7a6 chore: add libc field to node packages (#4856) 3 years ago
src 46e6187c89 chore: update license year (#6311) 2 years ago
test 19fff57191 wip 2 years 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 06fdcc0edd (NEXT) Apply Version Updates From Current Changes (#6701) 2 years ago
Cargo.toml d5ac76b53c chore(deps): update napi-rs, closes #6502 (#6513) 2 years 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 2adef93faf Update readme badges (#4696) 3 years ago
build.rs 46e6187c89 chore: update license year (#6311) 2 years ago
index.d.ts 46e6187c89 chore: update license year (#6311) 2 years ago
index.js 41f49aeae6 fix(cli.js): adb commands not working, closes #6659 (#6708) 2 years ago
jest.config.js 46e6187c89 chore: update license year (#6311) 2 years ago
main.d.ts 46e6187c89 chore: update license year (#6311) 2 years ago
main.js 46e6187c89 chore: update license year (#6311) 2 years ago
package.json 06fdcc0edd (NEXT) Apply Version Updates From Current Changes (#6701) 2 years ago
tauri.js 1c8229fbe2 fix(cli.js): detect `node-<version>` binary, closes #6427 (#6432) 2 years ago
yarn.lock d5ac76b53c chore(deps): update napi-rs, closes #6502 (#6513) 2 years ago

README.md

@tauri-apps/cli

status License test library 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, and yarn, 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 cli.rs.

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