Process

GitHub npm crates.io

API Reference

This plugin provides APIs to access the current process. To spawn child processes, see the shell plugin.

Setup

Install the plugin-process to get started.

Automatic

Use your project’s package manager to add the dependency:

npm

npm run tauri add process

Yarn

yarn run tauri add process

pnpm

pnpm tauri add process

Cargo

cargo tauri add process

Manual

1. Run cargo add tauri-plugin-process to add the plugin to the project’s dependencies in Cargo.toml.

2. Modify lib.rs to initialize the plugin:

   lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   pub fn run() {
       tauri::Builder::default()
           // Initialize the plugin
           .plugin(tauri_plugin_process::init())
           .run(tauri::generate_context!())
           .expect("error while running tauri application");
   }

3. If you’d like to utilize the plugin in JavaScript then install the npm package as well:

   npm

   npm install @tauri-apps/plugin-process

   Yarn

   yarn add @tauri-apps/plugin-process

   pnpm

   pnpm add @tauri-apps/plugin-process

Usage

The process plugin is available in both JavaScript and Rust.

JavaScript

import { exit, relaunch } from '@tauri-apps/plugin-process';

// exits the app with the given status code
await exit(0);

// restarts the app
await relaunch();

Rust

Note that app is an instance of AppHandle.

// exits the app with the given status code
app.exit(0);

// restarts the app
app.restart();