# cli

Parse arguments from your Command Line Interface.

This package is also accessible with `window.__TAURI__.cli` when [`build.withGlobalTauri`](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in `tauri.conf.json` is set to `true`.

## Interfaces

### `ArgMatch`

**Since**: 1.0.0

#### Properties

##### `occurrences`

>  **occurrences**: `number`

Number of occurrences

**Defined in:** [cli.ts:27](https://github.com/tauri-apps/tauri/blob/7082094/tooling/api/src/cli.ts#L27)

##### `value`

>  **value**: `null` \| `string` \| `boolean` \| `string`[]

string if takes value
boolean if flag
string[] or null if takes multiple values

**Defined in:** [cli.ts:23](https://github.com/tauri-apps/tauri/blob/7082094/tooling/api/src/cli.ts#L23)

### `CliMatches`

**Since**: 1.0.0

#### Properties

##### `args`

>  **args**: [`Record`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type )<`string`, [`ArgMatch`](cli.md#argmatch)\>

**Defined in:** [cli.ts:42](https://github.com/tauri-apps/tauri/blob/7082094/tooling/api/src/cli.ts#L42)

##### `subcommand`

>  **subcommand**: `null` \| [`SubcommandMatch`](cli.md#subcommandmatch)

**Defined in:** [cli.ts:43](https://github.com/tauri-apps/tauri/blob/7082094/tooling/api/src/cli.ts#L43)

### `SubcommandMatch`

**Since**: 1.0.0

#### Properties

##### `matches`

>  **matches**: [`CliMatches`](cli.md#climatches)

**Defined in:** [cli.ts:35](https://github.com/tauri-apps/tauri/blob/7082094/tooling/api/src/cli.ts#L35)

##### `name`

>  **name**: `string`

**Defined in:** [cli.ts:34](https://github.com/tauri-apps/tauri/blob/7082094/tooling/api/src/cli.ts#L34)

## Functions

### `getMatches`

> **getMatches**(): [`Promise`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )<[`CliMatches`](cli.md#climatches)\>

Parse the arguments provided to the current process and get the matches using the configuration defined [`tauri.cli`](https://tauri.app/v1/api/config/#tauriconfig.cli) in `tauri.conf.json`

**Example**

```typescript
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`]( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise )<[`CliMatches`](cli.md#climatches)\>