Skip to content
Tauri
Releases

shell

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

This package is also accessible with window.__TAURI__.shell when build.withGlobalTauri in tauri.conf.json is set to true.

The APIs must be added to tauri.allowlist.shell in tauri.conf.json:

{
"tauri": {
"allowlist": {
"shell": {
"all": true, // enable all shell APIs
"execute": true, // enable process spawn APIs
"sidecar": true, // enable spawning sidecars
"open": true // enable opening files/URLs using the default program
}
}
}
}

It is recommended to allowlist only the APIs you use for optimal bundle size and security.

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 allowlist, 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 shell allowlist 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 constructor. If it’s a sidecar, this must be the value defined on tauri.conf.json > tauri > 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"

Configuration:

{
"scope": [
{
"name": "run-git-commit",
"cmd": "git",
"args": ["commit", "-m", { "validator": "\\S+" }]
}
]
}

Usage:

import { Command } from '@tauri-apps/api/shell';
new Command('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

1.1.0

Constructors

constructor()
new Child(pid): Child
Parameters
ParameterType
pidnumber
Returns

Child

Source: shell.ts:325

Properties

PropertyTypeDescription
pidnumberThe child process pid.

Methods

kill()
kill(): Promise< void >

Kills the child process.

Returns

Promise< void >

A promise indicating the success or failure of the operation.

Source: shell.ts:361


write()
write(data): Promise< void >

Writes data to the stdin.

Example
import { Command } from '@tauri-apps/api/shell';
const command = new Command('node');
const child = await command.spawn();
await child.write('message');
await child.write([0, 1, 2, 3, 4, 5]);
Parameters
ParameterTypeDescription
datastring | Uint8ArrayThe message to write, either a string or a byte array.
Returns

Promise< void >

A promise indicating the success or failure of the operation.

Source: shell.ts:344


Command

The entry point for spawning child processes. It emits the close and error events.

Example

import { Command } from '@tauri-apps/api/shell';
const command = new Command('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);

Since

1.1.0

Extends

Constructors

constructor()
new Command(
program,
args = [],
options?): Command

Creates a new Command instance.

Parameters
ParameterTypeDefault valueDescription
programstringundefinedThe program name to execute.
It must be configured on tauri.conf.json > tauri > allowlist > shell > scope.
argsstring | string[][]Program arguments.
options?SpawnOptionsundefinedSpawn options.
Returns

Command

Overrides

EventEmitter.constructor

Source: shell.ts:413

Properties

PropertyTypeDescription
readonly stderrEventEmitter< "data" >Event emitter for the stderr. Emits the data event.
readonly stdoutEventEmitter< "data" >Event emitter for the stdout. Emits the data event.

Methods

addListener()
addListener(eventName, listener): this

Alias for emitter.on(eventName, listener).

Since

1.1.0

Parameters
ParameterType
eventName"error" | "close"
listener(…args) => void
Returns

this

Inherited from

EventEmitter.addListener

Source: shell.ts:164


execute()
execute(): Promise< ChildProcess >

Executes the command as a child process, waiting for it to finish and collecting all of its output.

Example
import { Command } from '@tauri-apps/api/shell';
const output = await new Command('echo', 'message').execute();
assert(output.code === 0);
assert(output.signal === null);
assert(output.stdout === 'message');
assert(output.stderr === '');
Returns

Promise< ChildProcess >

A promise resolving to the child process output.

Source: shell.ts:489


listenerCount()
listenerCount(eventName): number

Returns the number of listeners listening to the event named eventName.

Since

1.1.0

Parameters
ParameterType
eventName"error" | "close"
Returns

number

Inherited from

EventEmitter.listenerCount

Source: shell.ts:272


off()
off(eventName, listener): this

Removes the all specified listener from the listener array for the event eventName Returns a reference to the EventEmitter, so that calls can be chained.

Since

1.1.0

Parameters
ParameterType
eventName"error" | "close"
listener(…args) => void
Returns

this

Inherited from

EventEmitter.off

Source: shell.ts:221


on()
on(eventName, listener): this

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

Returns a reference to the EventEmitter, so that calls can be chained.

Since

1.0.0

Parameters
ParameterType
eventName"error" | "close"
listener(…args) => void
Returns

this

Inherited from

EventEmitter.on

Source: shell.ts:187


once()
once(eventName, listener): this

Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

Returns a reference to the EventEmitter, so that calls can be chained.

Since

1.1.0

Parameters
ParameterType
eventName"error" | "close"
listener(…args) => void
Returns

this

Inherited from

EventEmitter.once

Source: shell.ts:206


prependListener()
prependListener(eventName, listener): this

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

Returns a reference to the EventEmitter, so that calls can be chained.

Since

1.1.0

Parameters
ParameterType
eventName"error" | "close"
listener(…args) => void
Returns

this

Inherited from

EventEmitter.prependListener

Source: shell.ts:289


prependOnceListener()
prependOnceListener(eventName, listener): this

Adds a one-timelistener function for the event named eventName to thebeginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

Returns a reference to the EventEmitter, so that calls can be chained.

Since

1.1.0

Parameters
ParameterType
eventName"error" | "close"
listener(…args) => void
Returns

this

Inherited from

EventEmitter.prependOnceListener

Source: shell.ts:308


removeAllListeners()
removeAllListeners(event?): this

Removes all listeners, or those of the specified eventName.

Returns a reference to the EventEmitter, so that calls can be chained.

Since

1.1.0

Parameters
ParameterType
event?"error" | "close"
Returns

this

Inherited from

EventEmitter.removeAllListeners

Source: shell.ts:238


removeListener()
removeListener(eventName, listener): this

Alias for emitter.off(eventName, listener).

Since

1.1.0

Parameters
ParameterType
eventName"error" | "close"
listener(…args) => void
Returns

this

Inherited from

EventEmitter.removeListener

Source: shell.ts:173


spawn()
spawn(): Promise< Child >

Executes the command as a child process, returning a handle to it.

Returns

Promise< Child >

A promise resolving to the child process handle.

Source: shell.ts:451


sidecar()
static sidecar(
program,
args = [],
options?): Command

Creates a command to execute the given sidecar program.

Example
import { Command } from '@tauri-apps/api/shell';
const command = Command.sidecar('my-sidecar');
const output = await command.execute();
Parameters
ParameterTypeDefault valueDescription
programstringundefinedThe program to execute.
It must be configured on tauri.conf.json > tauri > allowlist > shell > scope.
argsstring | string[][]-
options?SpawnOptionsundefined-
Returns

Command

Source: shell.ts:436


EventEmitter

Since

1.0.0

Extended By

Type parameters

Parameter
E extends string

Constructors

constructor()
new EventEmitter<E>(): EventEmitter< E >
Type parameters
Parameter
E extends string
Returns

EventEmitter< E >

Methods

addListener()
addListener(eventName, listener): this

Alias for emitter.on(eventName, listener).

Since

1.1.0

Parameters
ParameterType
eventNameE
listener(…args) => void
Returns

this

Source: shell.ts:164


listenerCount()
listenerCount(eventName): number

Returns the number of listeners listening to the event named eventName.

Since

1.1.0

Parameters
ParameterType
eventNameE
Returns

number

Source: shell.ts:272


off()
off(eventName, listener): this

Removes the all specified listener from the listener array for the event eventName Returns a reference to the EventEmitter, so that calls can be chained.

Since

1.1.0

Parameters
ParameterType
eventNameE
listener(…args) => void
Returns

this

Source: shell.ts:221


on()
on(eventName, listener): this

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

Returns a reference to the EventEmitter, so that calls can be chained.

Since

1.0.0

Parameters
ParameterType
eventNameE
listener(…args) => void
Returns

this

Source: shell.ts:187


once()
once(eventName, listener): this

Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

Returns a reference to the EventEmitter, so that calls can be chained.

Since

1.1.0

Parameters
ParameterType
eventNameE
listener(…args) => void
Returns

this

Source: shell.ts:206


prependListener()
prependListener(eventName, listener): this

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

Returns a reference to the EventEmitter, so that calls can be chained.

Since

1.1.0

Parameters
ParameterType
eventNameE
listener(…args) => void
Returns

this

Source: shell.ts:289


prependOnceListener()
prependOnceListener(eventName, listener): this

Adds a one-timelistener function for the event named eventName to thebeginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

Returns a reference to the EventEmitter, so that calls can be chained.

Since

1.1.0

Parameters
ParameterType
eventNameE
listener(…args) => void
Returns

this

Source: shell.ts:308


removeAllListeners()
removeAllListeners(event?): this

Removes all listeners, or those of the specified eventName.

Returns a reference to the EventEmitter, so that calls can be chained.

Since

1.1.0

Parameters
ParameterType
event?E
Returns

this

Source: shell.ts:238


removeListener()
removeListener(eventName, listener): this

Alias for emitter.off(eventName, listener).

Since

1.1.0

Parameters
ParameterType
eventNameE
listener(…args) => void
Returns

this

Source: shell.ts:173

Interfaces

ChildProcess

Since

1.0.0

Properties

PropertyTypeDescription
codenull | numberExit code of the process. null if the process was terminated by a signal on Unix.
signalnull | numberIf the process was terminated by a signal, represents that signal.
stderrstringThe data that the process wrote to stderr.
stdoutstringThe data that the process wrote to stdout.

SpawnOptions

Since

1.0.0

Properties

PropertyTypeDescription
cwd?stringCurrent working directory.
encoding?stringCharacter encoding for stdout/stderr

Since

1.1.0
env?Record< string, string >Environment variables. set to null to clear the process env.

Functions

open()

open(path, openWith?): Promise< void >

Opens a path or URL with the system’s default app, or the one specified with openWith.

The openWith value must be one of firefox, google chrome, chromium safari, open, start, xdg-open, gio, gnome-open, kde-open or wslview.

Example

import { open } from '@tauri-apps/api/shell';
// opens the given URL on the default browser:
await open('https://github.com/tauri-apps/tauri');
// opens the given URL using `firefox`:
await open('https://github.com/tauri-apps/tauri', 'firefox');
// opens a file using the default program:
await open('/path/to/file');

Since

1.0.0

Parameters

ParameterTypeDescription
pathstringThe path or URL to open.
This value is matched against the string regex defined on tauri.conf.json > tauri > allowlist > shell > open,
which defaults to ^((mailto:\w+)|(tel:\w+)|(https?://\w+)).+.
openWith?stringThe app to open the file or URL with.
Defaults to the system default application for the specified path type.

Returns

Promise< void >

Source: shell.ts:564


© 2024 Tauri Contributors. CC-BY / MIT