archived-tauri-docs/docs/api/js/modules/cli.md

@tauri-apps/api / cli

Namespace: cli

Parse arguments from your Command Line Interface.

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

Interfaces

• ArgMatch
• CliMatches
• SubcommandMatch

Functions

getMatches

▸ getMatches(): Promise<CliMatches>

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

Returns

Promise<CliMatches>

A promise resolving to the parsed arguments.

Defined in

cli.ts:42