Skip to content
Tauri
Releases

cli

Parse arguments from your Command Line Interface.

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

Interfaces

ArgMatch

Since

1.0.0

Properties

PropertyTypeDescription
occurrencesnumberNumber of occurrences
valuenull | string | boolean | string[]string if takes value
boolean if flag
string[] or null if takes multiple values

CliMatches

Since

1.0.0

Properties

PropertyType
argsRecord< string, ArgMatch >
subcommandnull | SubcommandMatch

SubcommandMatch

Since

1.0.0

Properties

PropertyType
matchesCliMatches
namestring

Functions

getMatches()

getMatches(): Promise< CliMatches >

Parse the arguments provided to the current process and get the matches using the configuration defined tauri.cli in tauri.conf.json

Example

import { getMatches } from '@tauri-apps/api/cli';
const matches = await getMatches();
if (matches.subcommand?.name === 'run') {
// `./your-app run $ARGS` was executed
const args = matches.subcommand?.matches.args;
if ('debug' in args) {
// `./your-app run --debug` was executed
}
} else {
const args = matches.args;
// `./your-app $ARGS` was executed
}

Since

1.0.0

Returns

Promise< CliMatches >

Source: cli.ts:66


© 2024 Tauri Contributors. CC-BY / MIT