#tauri-plugin #shell #execute-command #plugin-api #script

sys tauri-plugin-shellx

Unlocked Tauri Shell Plugin

9 stable releases

2.0.12 Nov 14, 2024
2.0.11 Oct 3, 2024
2.0.10 Sep 11, 2024
2.0.8 Jul 17, 2024
0.0.5 Jun 19, 2024

#251 in GUI

Download history 1/week @ 2024-08-21 2/week @ 2024-08-28 127/week @ 2024-09-11 14/week @ 2024-09-18 10/week @ 2024-09-25 138/week @ 2024-10-02 11/week @ 2024-10-09 21/week @ 2024-10-16 37/week @ 2024-10-23 90/week @ 2024-10-30 61/week @ 2024-11-06 170/week @ 2024-11-13 108/week @ 2024-11-20 51/week @ 2024-11-27 43/week @ 2024-12-04

382 downloads per month

MIT license

190KB
1.5K SLoC

Rust 1.5K SLoC // 0.0% comments TypeScript 342 SLoC // 0.4% comments JavaScript 27 SLoC // 0.1% comments

Tauri Plugin Shellx

Currently this plugin only supports Tauri v2

Deploy Docs

This is a mod of the original official Tauri plugin tauri-plugin-shell.

The purpose is to provide the option to remove restrictions on shell commands (every command has to be pre-defined in capability).

This plugin allows you to execute any shell commands freely without any restrictions.

Docs

JS/TS API Documentation: https://huakunshen.github.io/tauri-plugin-shellx/

Installation

Make sure your npm package version and rust crate version are the same, or you may encounter compatibility issues.

npm install tauri-plugin-shellx-api
cargo add tauri-plugin-shellx

Usage

Install rust crate from https://crates.io/crates/tauri-plugin-shellx

Init plugin like this. The init() function takes a single unlocked argument.

let unlocked = true;
tauri::Builder::default()
    .plugin(tauri_plugin_shellx::init(unlocked))
...
  • If set to true, capability and permission settings are ignored.
  • If set to false, it will work like the original tauri-plugin-shell.

Example

An example app can be found at ./examples/tauri-app.

This example app is a simplified terminal emulator.

API

All API functions can be found in the API documentation.

Execute

const cmd = Command.create('echo', ['echo', 'Hello, World!'])
const out = await cmd.execute()
const stdout = out.stdout
// stdout === 'Hello, World!'

Spawn

Spawn a process for long-running tasks, and get stdout/stderr stream for real-time output.

const cmd = Command.create('ffmpeg', [
  '-i',
  '/Users/xxx/input.mp4',
  '/Users/xxx/output.mp4'
])

cmd.on('close', (data) => {
  console.log(
    `command finished with code ${data.code} and signal ${data.signal}`
  )
})
cmd.on('error', (error) => console.error(`command error: "${error}"`))
cmd.stdout.on('data', (line) => console.log(`command stdout: "${line}"`))
cmd.stderr.on('data', (line) => console.log(`command stderr: "${line}"`))

const child = await cmd.spawn()
console.log('pid:', child.pid)
await child.kill()

Extra APIs

Except for the original APIs, this plugin also provides some additional APIs:

Scripts Wrapper

These functions are simply wrappers for the execute function, which can be used to execute scripts.

You can also construct your own script runner wrapper

const powershellCmd = Command.create('powershell', ['-Command', script])
const bashCmd = Command.create('bash', ['-c', script])
  • makeBashScript
  • makePowershellScript
  • makeAppleScript
  • makePythonScript
  • makeZshScript
  • makeNodeScript
  • executeBashScript
  • executePowershellScript
  • executeAppleScript
  • executePythonScript
  • executeZshScript
  • executeNodeScript

Other Utilities

  • likelyOnWindows
  • hasCommand
  • fixPathEnv
    • If the command you run cannot be found in the PATH environment variable, you can use this function to fix it.

Dependencies

~21–62MB
~1M SLoC