@tauri-apps/plugin-shell

此内容尚不支持你的语言。

Access the system shell. Allows you to spawn child processes and manage files and URLs using their default application.

Security

This API has a scope configuration that forces you to restrict the programs and arguments that can be used.

Restricting access to the `open` API

On the configuration object, open: true means that the open API can be used with any URL, as the argument is validated with the ^((mailto:\w+)|(tel:\w+)|(https?://\w+)).+ regex. You can change that regex by changing the boolean value to a string, e.g. open: ^https://github.com/.

Restricting access to the `Command` APIs

The plugin permissions object has a scope field that defines an array of CLIs that can be used. Each CLI is a configuration object { name: string, cmd: string, sidecar?: bool, args?: boolean | Arg[] }.

name: the unique identifier of the command, passed to the Command.create function. If it’s a sidecar, this must be the value defined on tauri.conf.json > bundle > externalBin.
cmd: the program that is executed on this configuration. If it’s a sidecar, this value is ignored.
sidecar: whether the object configures a sidecar or a system program.
args: the arguments that can be passed to the program. By default no arguments are allowed.
- true means that any argument list is allowed.
- false means that no arguments are allowed.
- otherwise an array can be configured. Each item is either a string representing the fixed argument value or a { validator: string } that defines a regex validating the argument value.

Example scope configuration

CLI: git commit -m "the commit message"

Capability:

{
  "permissions": [
    {
      "identifier": "shell:allow-execute",
      "allow": [
        {
          "name": "run-git-commit",
          "cmd": "git",
          "args": ["commit", "-m", { "validator": "\\S+" }]
        }
      ]
    }
  ]
}

Usage:

import { Command } from '@tauri-apps/plugin-shell'
Command.create('run-git-commit', ['commit', '-m', 'the commit message'])

Trying to execute any API with a program not configured on the scope results in a promise rejection due to denied access.

Classes

Child

Since

2.0.0

Constructors

new Child()

new Child(pid): Child

Parameters

Parameter	Type
`pid`	`number`

Property	Modifier	Type	Description	Defined in
`stderr`	`readonly`	`EventEmitter`<`OutputEvents`<`O`>>	Event emitter for the `stderr`. Emits the `data` event.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L384
`stdout`	`readonly`	`EventEmitter`<`OutputEvents`<`O`>>	Event emitter for the `stdout`. Emits the `data` event.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L382

Parameter	Type
`program`	`string`
`args`?	`string` \| `string`[]
`options`?	`SpawnOptions` & `object`

Property	Type	Description	Defined in
`code`	`null` \| `number`	Exit code of the process. `null` if the process was terminated by a signal on Unix.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L94
`signal`	`null` \| `number`	If the process was terminated by a signal, represents that signal.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L96
`stderr`	`O`	The data that the process wrote to `stderr`.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L100
`stdout`	`O`	The data that the process wrote to `stdout`.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L98

Property	Type	Defined in
`close`	`TerminatedPayload`	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L345
`error`	`string`	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L346

Property	Type	Description	Defined in
`cwd?`	`string`	Current working directory.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L73
`encoding?`	`string`	Character encoding for stdout/stderr Since 2.0.0	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L81
`env?`	`Record`<`string`, `string`>	Environment variables. set to `null` to clear the process env.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L75

Parameter	Type	Description
`path`	`string`	The path or URL to open. This value is matched against the string regex defined on `tauri.conf.json > plugins > shell > open`, which defaults to `^((mailto:\w+)
`openWith`?	`string`	The app to open the file or URL with. Defaults to the system default application for the specified path type.

Parameter	Type
`eventName`	`N`
`listener`	(`arg`) => `void`

Parameter	Type
`eventName`	`N`
`listener`	(`arg`) => `void`

Parameter	Type
`eventName`	`N`
`listener`	(`arg`) => `void`

Parameter	Type
`eventName`	`N`
`listener`	(`arg`) => `void`

@tauri-apps/plugin-shell

Restricting access to the open API

Restricting access to the Command APIs

Restricting access to the `open` API

Restricting access to the `Command` APIs