Lucas Fernandes NogueiraandLucas Nogueira
152ff5bb6d
* refactor(shell)!: remove deprecated open API `open` has been deprecated since 2.1.0 in favor of tauri-plugin-opener. This removes: - the `open` command and its `allow-open`/`deny-open` permissions (`shell:default` now grants nothing) - the `plugins > shell > open` configuration; `init()` returns `TauriPlugin<R>` again - `Shell::open`, the `tauri_plugin_shell::open` module and `Error::UnknownProgramName` - the `open` JavaScript function - the Android and iOS plugins, since `open` was their only command * chore(examples): drop the now empty shell:default permission set --------- Co-authored-by: Lucas Nogueira <lucas@crabnebula.dev>
2.6 KiB
Access the system shell. Allows you to spawn child processes.
To open files and URLs with their default application, use tauri-plugin-opener.
| Platform | Supported |
|---|---|
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | x |
| iOS | x |
Install
This plugin requires a Rust version of at least 1.95
There are three general methods of installation that we can recommend.
- Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
- Pull sources directly from Github using git tags / revision hashes (most secure)
- 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
[dependencies]
tauri-plugin-shell = "2.0.0"
# alternatively with Git:
tauri-plugin-shell = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }
You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
pnpm add @tauri-apps/plugin-shell
# or
npm add @tauri-apps/plugin-shell
# or
yarn add @tauri-apps/plugin-shell
Usage
First you need to register the core plugin with Tauri:
src-tauri/src/lib.rs
fn main() {
tauri::Builder::default()
.plugin(tauri_plugin_shell::init())
.run(tauri::generate_context!())
.expect("error while running tauri application");
}
Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
import { Command } from '@tauri-apps/plugin-shell'
Command.create('git', ['commit', '-m', 'the commit message'])
Contributing
PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
Partners
|
For the complete list of sponsors please visit our website and Open Collective.
License
Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.
MIT or MIT/Apache 2.0 where applicable.