Shell

GitHubnpmcrates.io

Referencia de API

Accede al shell del sistema. Te permite generar procesos hijo.

Plataformas Soportadas

Este plugin requiere una versión de Rust de al menos 1.77.2

Plataforma	Nivel	Notas
windows
linux
macos
android		Solo permite abrir URLs a través de open
ios		Solo permite abrir URLs a través de open

Opener

Si estás buscando documentación para la API shell.open, en su lugar consulta el nuevo plugin Opener.

Configuración

Instala el plugin shell para comenzar.

Automático

Usa el gestor de paquetes de tu proyecto para agregar la dependencia:

npm

npm run tauri add shell

yarn

yarn run tauri add shell

pnpm

pnpm tauri add shell

deno

deno task tauri add shell

bun

bun tauri add shell

cargo

cargo tauri add shell

Manual

1. Ejecuta el siguiente comando en la carpeta src-tauri para agregar el plugin a las dependencias del proyecto en Cargo.toml:

   cargo add tauri-plugin-shell

2. Modifica lib.rs para inicializar el plugin:

   src-tauri/src/lib.rs

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

3. Instala los bindings de JavaScript utilizando tu gestor de paquetes de JavaScript preferido:

   npm

   npm install @tauri-apps/plugin-shell

   yarn

   yarn add @tauri-apps/plugin-shell

   pnpm

   pnpm add @tauri-apps/plugin-shell

   deno

   deno add npm:@tauri-apps/plugin-shell

   bun

   bun add @tauri-apps/plugin-shell

Uso

El plugin shell está disponible tanto en JavaScript como en Rust.

JavaScript

import { Command } from '@tauri-apps/plugin-shell';
// when using `"withGlobalTauri": true`, you may use
// const { Command } = window.__TAURI__.shell;

let result = await Command.create('exec-sh', [
  '-c',
  "echo 'Hello World!'",
]).execute();
console.log(result);

Rust

use tauri_plugin_shell::ShellExt;

let shell = app_handle.shell();
let output = tauri::async_runtime::block_on(async move {
    shell
        .command("echo")
        .args(["Hello from Rust!"])
        .output()
        .await
        .unwrap()
});
if output.status.success() {
    println!("Result: {:?}", String::from_utf8(output.stdout));
} else {
    println!("Exit with code: {}", output.status.code().unwrap());
}

Permisos

De forma predeterminada, todos los comandos y alcances (scopes) potencialmente peligrosos del plugin están bloqueados y no se puede acceder a ellos. Debes modificar los permisos en tu configuración de capabilities para habilitarlos.

Consulta la Visión General de Capacidades para obtener más información y la guía paso a paso para usar permisos de plugins.

src-tauri/capabilities/default.json

{
  "$schema": "../gen/schemas/desktop-schema.json",
  "identifier": "main-capability",
  "description": "Capability for the main window",
  "windows": ["main"],
  "permissions": [
    {
      "identifier": "shell:allow-execute",
      "allow": [
        {
          "name": "exec-sh",
          "cmd": "sh",
          "args": [
            "-c",
            {
              "validator": "\\S+"
            }
          ],
          "sidecar": false
        }
      ]
    }
  ]
}

Permiso Predeterminado

Este conjunto de permisos configura qué funcionalidad de shell se expone por defecto.

Permisos Otorgados

Permite usar la funcionalidad open con un scope razonable preconfigurado. Permitirá abrir enlaces http(s)://, tel: y mailto:.

Este conjunto de permisos predeterminado incluye lo siguiente:

• allow-open

Tabla de Permisos

Identificador	Descripción
shell:allow-execute	Habilita el comando execute sin ningún scope preconfigurado.
shell:deny-execute	Deniega el comando execute sin ningún scope preconfigurado.
shell:allow-kill	Habilita el comando kill sin ningún scope preconfigurado.
shell:deny-kill	Deniega el comando kill sin ningún scope preconfigurado.
shell:allow-open	Habilita el comando open sin ningún ámbito preconfigurado.
shell:deny-open	Deniega el comando open sin ningún ámbito preconfigurado.
shell:allow-spawn	Habilita el comando spawn sin ningún scope preconfigurado.
shell:deny-spawn	Deniega el comando spawn sin ningún scope preconfigurado.
shell:allow-stdin-write	Habilita el comando stdin_write sin ningún scope preconfigurado.
shell:deny-stdin-write	Deniega el comando stdin_write sin ningún scope preconfigurado.