CliFlag

Official

Both Official Unofficial

Both Own Inherited

The data passed to the CLI.

Import:

import type { CliFlag } from 'obsidian';

Signature:

export interface CliFlag

Properties

	Property	Type	Description
	description	string	Description shown in help and autocomplete
	required?	boolean	Whether this flag is required.
	value?	string	Value placeholder (e.g., '<filename>', '<path>'). Omit for boolean flags.

---

Links to this page:

• CliHandlerEntry