@tauri-apps/plugin-cli

Analiza argumentos de tu Interfaz de Línea de Comandos (CLI).

Interfaces

ArgMatch

Desde

2.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
occurrences	number	Número de ocurrencias	Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L26
value	null | string | boolean | string[]	string si toma un valor, boolean si es una flag, string[] o null si toma múltiples valores	Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L22

---

CliMatches

Desde

2.0.0

Propiedades

Propiedad	Tipo	Definido en
args	Registro (Record)<string, ArgMatch>	Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L41
subcommand	null | SubcommandMatch	Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L42

---

SubcommandMatch

Desde

2.0.0

Propiedades

Propiedad	Tipo	Definido en
matches	CliMatches	Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L34
name	string	Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L33

Funciones

getMatches()

function getMatches(): Promise<CliMatches>

Analiza los argumentos proporcionados al proceso actual y obtiene las coincidencias utilizando la configuración definida tauri.cli en tauri.conf.json

Devuelve

Promise<CliMatches>

Ejemplo

import { getMatches } from '@tauri-apps/plugin-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
}

Desde

2.0.0

Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L66