Skip to content

First-party source

Desktop command contract: Obsidian CLI, retrieved 2026-08-29 EDT. See the dated source ledger.

Properties

Fresh

List aliases and properties across the vault or for a specific file. Set, remove, and read individual property values.

Commands related to Properties.

aliases

List aliases in the vault. Use active or file/path to show aliases for a specific file.

bash
file=<name>        # file name
path=<path>        # file path

total              # return alias count
verbose            # include file paths
active             # show aliases for active file

properties

List properties in the vault. Use active or file/path to show properties for a specific file.

bash
file=<name>        # show properties for file
path=<path>        # show properties for path
name=<name>        # get specific property count
sort=count         # sort by count (default: name)
format=yaml|json|tsv  # output format (default: yaml)

total              # return property count
counts             # include occurrence counts
active             # show properties for active file

property:set

Set a property on a file (default: active file).

bash
name=<name>                                    # (required) property name
value=<value>                                  # (required) property value
type=text|list|number|checkbox|date|datetime   # property type
file=<name>                                    # file name
path=<path>                                    # file path

property:remove

Remove a property from a file (default: active file).

bash
name=<name>        # (required) property name
file=<name>        # file name
path=<path>        # file path

property:read

Read a property value from a file (default: active file).

bash
name=<name>        # (required) property name
file=<name>        # file name
path=<path>        # file path

See also

Unofficial SOP mirror. Built for terminal-driven and agentic Obsidian workflows.