@tauri-apps/plugin-shell

存取系統 Shell。允許您產生子程序，並使用預設應用程式管理檔案和 URL。

安全性

此 API 具有作用域設定，強制您限制可以使用的程式和引數。

限制對 `open` API 的存取

在設定物件中，open: true 表示 open API 可以與任何 URL 一起使用，因為引數會使用 ^((mailto:\w+)|(tel:\w+)|(https?://\w+)).+ 正規表示式驗證。您可以將布林值變更為字串來變更該正規表示式，例如 open: ^https://github.com/。

限制對 `Command` API 的存取

外掛程式權限物件具有 scope 欄位，其定義可以使用的 CLI 陣列。每個 CLI 都是一個設定物件 { name: string, cmd: string, sidecar?: bool, args?: boolean | Arg[] }。

name：命令的唯一識別符，傳遞至 Command.create 函式。如果是 Sidecar，則這必須是在 tauri.conf.json > bundle > externalBin 上定義的值。
cmd：在此設定上執行的程式。如果是 Sidecar，則此值會被忽略。
sidecar：物件是否設定 Sidecar 或系統程式。
args：可以傳遞給程式的引數。預設情況下，不允許任何引數。
- true 表示允許任何引數清單。
- false 表示不允許任何引數。
- 否則可以設定陣列。每個項目可以是代表固定引數值的字串，或定義驗證引數值的正規表示式的 { validator: string }。

範例作用域設定

CLI：git commit -m "the commit message"

功能

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

用法

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

嘗試使用未在作用域中設定的程式執行任何 API 會導致 Promise 遭到拒絕，因為存取遭拒。

類別

Child

自從

2.0.0

建構函式

new Child()

new Child(pid): Child

參數

參數	類型
`pid`	`number`

回傳

Child

來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L301

屬性

屬性	類型	描述	定義於
`pid`	`number`	子程序的 `pid`。	來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L299

方法

kill()

kill(): Promise<void>

終止子程序。

回傳

Promise<void>

指示操作成功或失敗的 Promise。

自從

2.0.0

來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L336

write()

write(data): Promise<void>

將 data 寫入 stdin。

參數

參數	類型	描述
`data`	`IOPayload` \| `number`[]	要寫入的訊息，可以是字串或位元組陣列。

回傳

Promise<void>

指示操作成功或失敗的 Promise。

範例

import { Command } from '@tauri-apps/plugin-shell';
const command = Command.create('node');
const child = await command.spawn();
await child.write('message');
await child.write([0, 1, 2, 3, 4, 5]);

自從

2.0.0

來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L322

Command<O>

用於產生子程序的進入點。它會發出 close 和 error 事件。

範例

import { Command } from '@tauri-apps/plugin-shell';
const command = Command.create('node');
command.on('close', data => {
  console.log(`command finished with code ${data.code} and signal ${data.signal}`)
});
command.on('error', error => console.error(`command error: "${error}"`));
command.stdout.on('data', line => console.log(`command stdout: "${line}"`));
command.stderr.on('data', line => console.log(`command stderr: "${line}"`));

const child = await command.spawn();
console.log('pid:', child.pid);

自從

2.0.0

屬性	修飾詞	類型	描述	定義於
`stderr`	`readonly`	`EventEmitter`<`OutputEvents`<`O`>>	`stderr` 的事件發射器。發出 `data` 事件。	來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L384
`stdout`	`readonly`	`EventEmitter`<`OutputEvents`<`O`>>	`stdout` 的事件發射器。發出 `data` 事件。	來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L382

參數	類型
`program`	`string`
`args`?	`string` \| `string`[]
`options`?	`SpawnOptions` & `object`

屬性	類型	描述	定義於
`code`	`null` \| `number`	程序的結束代碼。如果程序在 Unix 上被訊號終止，則為 `null`。	來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L94
`signal`	`null` \| `number`	如果程序被訊號終止，則表示該訊號。	來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L96
`stderr`	`O`	程序寫入 `stderr` 的資料。	來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L100
`stdout`	`O`	程序寫入 `stdout` 的資料。	來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L98

屬性	類型	定義於
`close`	`TerminatedPayload`	來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L345
`error`	`string`	來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L346

屬性	類型	描述	定義於
`cwd?`	`string`	目前工作目錄。	來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L73
`encoding?`	`string`	stdout/stderr 的字元編碼自從 2.0.0	來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L81
`env?`	`Record`<`string`, `string`>	環境變數。設定為 `null` 以清除程序環境。	來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/shell/guest-js/index.ts#L75

參數	類型	描述
`path`	`string`	要開啟的路徑或 URL。此值會與 `tauri.conf.json > plugins > shell > open` 上定義的字串正規表示式比對，預設為 `^((mailto:\w+)
`openWith`?	`string`	用於開啟檔案或 URL 的應用程式。預設為指定路徑類型的系統預設應用程式。

參數	類型
`eventName`	`N`
`listener`	(`arg`) => `void`

參數	類型
`eventName`	`N`
`listener`	(`arg`) => `void`

參數	類型
`eventName`	`N`
`listener`	(`arg`) => `void`

參數	類型
`eventName`	`N`
`listener`	(`arg`) => `void`

@tauri-apps/plugin-shell

限制對 open API 的存取

限制對 Command API 的存取

限制對 `open` API 的存取

限制對 `Command` API 的存取