mirror of
https://github.com/tauri-apps/plugins-workspace.git
synced 2026-04-21 11:26:15 +02:00
Lorenzo Lewis
6f01bc11ab
* set readme banners to absolute url Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * Revert "set readme banners to absolute url" This reverts commitc46b464c69. * update banners to absolute paths Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * Revert "update banners to absolute paths" This reverts commitc8b8f9309e. * fix banner paths Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * Revert "fix banner paths" This reverts commit27edc59b41. * fix banners...again Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> --------- Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
79 lines
2.4 KiB
Markdown
79 lines
2.4 KiB
Markdown
|
|
|
|
This plugin provides APIs to access the current process. To spawn child processes, see the [`shell`](https://github.com/tauri-apps/tauri-plugin-shell) plugin.
|
|
|
|
## Install
|
|
|
|
_This plugin requires a Rust version of at least **1.65**_
|
|
|
|
There are three general methods of installation that we can recommend.
|
|
|
|
1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
|
|
2. Pull sources directly from Github using git tags / revision hashes (most secure)
|
|
3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)
|
|
|
|
Install the Core plugin by adding the following to your `Cargo.toml` file:
|
|
|
|
`src-tauri/Cargo.toml`
|
|
|
|
```toml
|
|
[dependencies]
|
|
tauri-plugin-process = "2.0.0-alpha"
|
|
# alternatively with Git:
|
|
tauri-plugin-process = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }
|
|
```
|
|
|
|
You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
|
|
|
|
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
|
|
|
|
```sh
|
|
pnpm add @tauri-apps/plugin-process
|
|
# or
|
|
npm add @tauri-apps/plugin-process
|
|
# or
|
|
yarn add @tauri-apps/plugin-process
|
|
|
|
# alternatively with Git:
|
|
pnpm add https://github.com/tauri-apps/tauri-plugin-process#v2
|
|
# or
|
|
npm add https://github.com/tauri-apps/tauri-plugin-process#v2
|
|
# or
|
|
yarn add https://github.com/tauri-apps/tauri-plugin-process#v2
|
|
```
|
|
|
|
## Usage
|
|
|
|
First you need to register the core plugin with Tauri:
|
|
|
|
`src-tauri/src/main.rs`
|
|
|
|
```rust
|
|
fn main() {
|
|
tauri::Builder::default()
|
|
.plugin(tauri_plugin_process::init())
|
|
.run(tauri::generate_context!())
|
|
.expect("error while running tauri application");
|
|
}
|
|
```
|
|
|
|
Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
|
|
|
|
```javascript
|
|
import { exit, relaunch } from "@tauri-apps/plugin-process";
|
|
// exit the app with the given status code
|
|
await exit(0);
|
|
// restart the app
|
|
await relaunch();
|
|
```
|
|
|
|
## Contributing
|
|
|
|
PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
|
|
|
|
## License
|
|
|
|
Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.
|
|
|
|
MIT or MIT/Apache 2.0 where applicable.
|