Obsidian Headless

https://obsidian.md/help/headless
Admin
Obsidian Headless is a command line client for Obsidian services that lets you sync vaults without...
Tokens:13,794
Snippets:222
Trust Score:9.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### plugin:install

Source: https://obsidian.md/help/cli

Install a community plugin.

```APIDOC
## plugin:install

### Description
Install a community plugin.

### Parameters
- **id** (string) - Required - plugin ID
- **enable** (flag) - Optional - enable after install
```

--------------------------------

### theme:install

Source: https://obsidian.md/help/cli

Installs a community theme.

```APIDOC
## theme:install

### Description
Install a community theme.

### Parameters
#### Query Parameters
- **name** (string) - Required - Theme name
- **enable** (flag) - Optional - Activate after install
```

--------------------------------

### Install community theme

Source: https://obsidian.md/help/cli

Installs a community theme by name, with an option to enable it immediately.

```bash
name=<name>        # (required) theme name

enable             # activate after install
```

--------------------------------

### Install community plugin command

Source: https://obsidian.md/help/cli

Installs a community plugin by its ID.

```text
id=<id>            # (required) plugin ID

enable             # enable after install
```

--------------------------------

### plugins

Source: https://obsidian.md/help/cli

List installed plugins.

```APIDOC
## plugins

### Description
List installed plugins.

### Parameters
- **filter** (string) - Optional - filter by plugin type (core|community)
- **versions** (flag) - Optional - include version numbers
- **format** (string) - Optional - output format (json|tsv|csv, default: tsv)
```

--------------------------------

### List themes

Source: https://obsidian.md/help/cli

Lists installed themes, optionally including version numbers.

```bash
versions           # include version numbers
```

--------------------------------

### Install Obsidian Headless

Source: https://obsidian.md/help/headless

Install the package globally using npm. Requires Node.js 22 or later.

```bash
npm install -g obsidian-headless
```

--------------------------------

### themes

Source: https://obsidian.md/help/cli

Lists all installed themes.

```APIDOC
## themes

### Description
List installed themes.

### Parameters
#### Query Parameters
- **versions** (flag) - Optional - Include version numbers
```

--------------------------------

### Task Listing Examples

Source: https://obsidian.md/help/cli

Common usage patterns for listing and filtering tasks.

```bash
# List all tasks in the vault
tasks

# List incomplete tasks in the vault
tasks todo

# List completed tasks from a specific file
tasks file=Recipe done

# List tasks from today's daily note
tasks daily

# Count tasks in daily note
tasks daily total

# List tasks with file paths and line numbers
tasks verbose

# Filter by custom status (quote special chars)
tasks 'status=?'
```

--------------------------------

### List plugins command

Source: https://obsidian.md/help/cli

Lists installed plugins with optional filtering and formatting.

```text
filter=core|community  # filter by plugin type

versions               # include version numbers
format=json|tsv|csv    # output format (default: tsv)
```

--------------------------------

### Task Update Examples

Source: https://obsidian.md/help/cli

Common usage patterns for showing and updating specific tasks.

```bash
# Show task info
task file=Recipe line=8
task ref="Recipe.md:8"

# Toggle task completion
task ref="Recipe.md:8" toggle

# Toggle task in daily note
task daily line=3 toggle

# Set task status
task file=Recipe line=8 done      # → [x]
task file=Recipe line=8 todo      # → [ ]
task file=Recipe line=8 status=-  # → [-]
task daily line=3 done            # Mark daily note task as done
```

--------------------------------

### Get plugin info command

Source: https://obsidian.md/help/cli

Retrieves information for a specific plugin by its ID.

```text
id=<plugin-id>     # (required) plugin ID
```

--------------------------------

### plugin

Source: https://obsidian.md/help/cli

Get plugin info.

```APIDOC
## plugin

### Description
Get plugin info.

### Parameters
- **id** (string) - Required - plugin ID
```

--------------------------------

### hotkey

Source: https://obsidian.md/help/cli

Get hotkey for a command.

```APIDOC
## hotkey

### Description
Get hotkey for a command.

### Parameters
#### Query Parameters
- **id** (string) - Required - command ID
- **verbose** (boolean) - Optional - show if custom or default
```

--------------------------------

### Get command hotkey

Source: https://obsidian.md/help/cli

Retrieve the hotkey configuration for a specific command ID.

```text
id=<command-id>    # (required) command ID

verbose            # show if custom or default

```

--------------------------------

### Uninstall theme

Source: https://obsidian.md/help/cli

Removes an installed theme by name.

```bash
name=<name>        # (required) theme name
```

--------------------------------

### Get Tag Information

Source: https://obsidian.md/help/cli

Retrieves information for a specific tag, including occurrence counts and file lists.

```bash
name=<tag>         # (required) tag name

total              # return occurrence count
verbose            # include file list and count
```

--------------------------------

### Create a note with default settings

Source: https://obsidian.md/help/cli

Creates a new note using the default name.

```bash
# Create a new note using the default "Untitled" name
obsidian create
```

--------------------------------

### Create a new item in a base

Source: https://obsidian.md/help/cli

Parameters for the base:create command to specify file location, view, and initial content.

```text
file=<name>        # base file name
path=<path>        # base file path
view=<name>        # view name
name=<name>        # new file name
content=<text>     # initial content

open               # open file after creating
newtab             # open in new tab
```

--------------------------------

### List properties command options

Source: https://obsidian.md/help/cli

Options for listing properties, including sorting and output formatting.

```text
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
```

--------------------------------

### Create a note with parameters

Source: https://obsidian.md/help/cli

Assigns values to parameters. Wrap values containing spaces in quotes.

```bash
# Create a new note called "Note" with content "Hello world"
obsidian create name=Note content="Hello world"
```

--------------------------------

### Show file outline command

Source: https://obsidian.md/help/cli

Displays the headings for the specified or active file.

```text
file=<name>        # file name
path=<path>        # file path
format=tree|md|json  # output format (default: tree)

total              # return heading count
```

--------------------------------

### create

Source: https://obsidian.md/help/cli

Create or overwrite a file.

```APIDOC
## create

### Description
Create or overwrite a file.

### Parameters
- **name** (string) - Optional - file name
- **path** (string) - Optional - file path
- **content** (string) - Optional - initial content
- **template** (string) - Optional - template to use
- **overwrite** (flag) - Optional - overwrite if file exists
- **open** (flag) - Optional - open file after creating
- **newtab** (flag) - Optional - open in new tab
```

--------------------------------

### plugin:enable

Source: https://obsidian.md/help/cli

Enable a plugin.

```APIDOC
## plugin:enable

### Description
Enable a plugin.

### Parameters
- **id** (string) - Required - plugin ID
- **filter** (string) - Optional - plugin type (core|community)
```

--------------------------------

### Set active theme

Source: https://obsidian.md/help/cli

Sets the active theme by name, or reverts to default if empty.

```bash
name=<name>        # (required) theme name (empty for default)
```

--------------------------------

### Set property command options

Source: https://obsidian.md/help/cli

Required and optional parameters for setting a property value on a file.

```text
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
```

--------------------------------

### List hotkeys

Source: https://obsidian.md/help/cli

List hotkeys for all commands with options for formatting and verbosity.

```text
total              # return hotkey count
verbose            # show if hotkey is custom
format=json|tsv|csv  # output format (default: tsv)

```

--------------------------------

### open

Source: https://obsidian.md/help/cli

Open a file in the vault.

```APIDOC
## open

### Description
Open a file.

### Parameters
- **file** (string) - Optional - file name
- **path** (string) - Optional - file path
- **newtab** (flag) - Optional - open in new tab
```

--------------------------------

### hotkeys

Source: https://obsidian.md/help/cli

List hotkeys for all commands.

```APIDOC
## hotkeys

### Description
List hotkeys for all commands.

### Parameters
#### Query Parameters
- **total** (boolean) - Optional - return hotkey count
- **verbose** (boolean) - Optional - show if hotkey is custom
- **format** (string) - Optional - output format (json|tsv|csv, default: tsv)
```

--------------------------------

### List aliases command options

Source: https://obsidian.md/help/cli

Options for listing aliases in the vault or for a specific file.

```text
file=<name>        # file name
path=<path>        # file path

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

--------------------------------

### Add a bookmark

Source: https://obsidian.md/help/cli

Parameters for the bookmark command to specify the target file, folder, search query, or URL.

```text
file=<path>        # file to bookmark
subpath=<subpath>  # subpath (heading or block) within file
folder=<path>      # folder to bookmark
search=<query>     # search query to bookmark
url=<url>          # URL to bookmark
title=<title>      # bookmark title
```

--------------------------------

### List templates

Source: https://obsidian.md/help/cli

Returns the total count of available templates.

```bash
total              # return template count
```

--------------------------------

### Create or overwrite a file

Source: https://obsidian.md/help/cli

Creates a new file or overwrites an existing one with specified content or a template.

```text
name=<name>        # file name
path=<path>        # file path
content=<text>     # initial content
template=<name>    # template to use

overwrite          # overwrite if file exists
open               # open file after creating
newtab             # open in new tab
```

--------------------------------

### theme:set

Source: https://obsidian.md/help/cli

Sets the active theme.

```APIDOC
## theme:set

### Description
Set active theme.

### Parameters
#### Query Parameters
- **name** (string) - Required - Theme name (empty for default)
```

--------------------------------

### Show theme info

Source: https://obsidian.md/help/cli

Displays information about the active theme or a specific theme by name.

```bash
name=<name>        # theme name for details
```

--------------------------------

### Authenticate with Obsidian Headless

Source: https://obsidian.md/help/headless

Commands for managing user authentication sessions.

```bash
ob login
```

```bash
ob login [--email <email>] [--password <password>] [--mfa <code>]
```

```bash
ob logout
```

--------------------------------

### Open a file

Source: https://obsidian.md/help/cli

Opens a specified file, optionally in a new tab.

```text
file=<name>        # file name
path=<path>        # file path

newtab             # open in new tab
```

--------------------------------

### workspace:load

Source: https://obsidian.md/help/cli

Loads a saved workspace.

```APIDOC
## workspace:load

### Description
Load a saved workspace.

### Parameters
- **name** (string) - Required - Workspace name
```

--------------------------------

### Create unique note

Source: https://obsidian.md/help/cli

Creates a new note with specified content and pane configuration.

```bash
name=<text>        # note name
content=<text>     # initial content
paneType=tab|split|window    # pane type to open in

open               # open file after creating
```

--------------------------------

### plugins:enabled

Source: https://obsidian.md/help/cli

List enabled plugins.

```APIDOC
## plugins:enabled

### Description
List enabled plugins.

### Parameters
- **filter** (string) - Optional - filter by plugin type (core|community)
- **versions** (flag) - Optional - include version numbers
- **format** (string) - Optional - output format (json|tsv|csv, default: tsv)
```

--------------------------------

### Obsidian CLI Configuration

Source: https://obsidian.md/help/cli

Frontmatter configuration for the Obsidian CLI documentation page.

```yaml
permalink: cli
description: Anything you can do in Obsidian can be done from the command line.
```

--------------------------------

### Search with context

Source: https://obsidian.md/help/cli

Performs a search and returns grep-style output with line context.

```text
query=<text>       # (required) search query
path=<folder>      # limit to folder
limit=<n>          # max files
format=text|json   # output format (default: text)

case               # case sensitive
```

--------------------------------

### Create a note with multiline content

Source: https://obsidian.md/help/cli

Uses escape sequences for formatting content.

```bash
obsidian create name=Note content="# Title\n\nBody text"
```

--------------------------------

### daily:prepend

Source: https://obsidian.md/help/cli

Prepend content to daily note.

```APIDOC
## daily:prepend

### Description
Prepend content to daily note.

### Parameters
#### Query Parameters
- **content** (string) - Required - content to prepend
- **paneType** (string) - Optional - pane type to open in (tab|split|window)
- **inline** (boolean) - Optional - prepend without newline
- **open** (boolean) - Optional - open file after adding
```

--------------------------------

### Show folder information

Source: https://obsidian.md/help/cli

Retrieves specific information about a folder.

```text
path=<path>              # (required) folder path
info=files|folders|size  # return specific info only
```

--------------------------------

### List orphan files command

Source: https://obsidian.md/help/cli

Lists files that have no incoming links.

```text
total              # return orphan count
```

--------------------------------

### commands

Source: https://obsidian.md/help/cli

List available command IDs.

```APIDOC
## commands

### Description
List available command IDs.

### Parameters
#### Query Parameters
- **filter** (string) - Optional - filter by ID prefix
```

--------------------------------

### General Commands

Source: https://obsidian.md/help/cli

System-level commands for managing the Obsidian application state.

```APIDOC
## help
Show list of all available commands.

### Parameters
- **command** (string) - Optional - Show help for a specific command.

## version
Show Obsidian version.

## reload
Reload the app window.

## restart
Restart the app.
```

--------------------------------

### outline

Source: https://obsidian.md/help/cli

Show headings for the current file.

```APIDOC
## outline

### Description
Show headings for the current file.

### Parameters
- **file** (string) - Optional - file name
- **path** (string) - Optional - file path
- **format** (string) - Optional - output format (tree|md|json, default: tree)
- **total** (flag) - Optional - return heading count
```

--------------------------------

### command

Source: https://obsidian.md/help/cli

Execute an Obsidian command.

```APIDOC
## command

### Description
Execute an Obsidian command.

### Parameters
#### Query Parameters
- **id** (string) - Required - command ID to execute
```

--------------------------------

### tab:open

Source: https://obsidian.md/help/cli

Opens a new tab.

```APIDOC
## tab:open

### Description
Open a new tab.

### Parameters
- **group** (string) - Optional - Tab group ID
- **file** (string) - Optional - File to open
- **view** (string) - Optional - View type to open
```

--------------------------------

### List published files

Source: https://obsidian.md/help/cli

Returns the count of published files.

```text
total              # return published file count
```

--------------------------------

### prepend

Source: https://obsidian.md/help/cli

Prepend content after frontmatter.

```APIDOC
## prepend

### Description
Prepend content after frontmatter (default: active file).

### Parameters
- **file** (string) - Optional - file name
- **path** (string) - Optional - file path
- **content** (string) - Required - content to prepend
- **inline** (flag) - Optional - prepend without newline
```

--------------------------------

### Manually Create macOS CLI Symlink

Source: https://obsidian.md/help/cli

Create the CLI symlink manually if the automatic registration fails.

```bash
sudo ln -sf /Applications/Obsidian.app/Contents/MacOS/obsidian-cli /usr/local/bin/obsidian
```

--------------------------------

### Show file information

Source: https://obsidian.md/help/cli

Displays metadata for the active file or a specified file.

```text
file=<name>        # file name
path=<path>        # file path
```

```text
path       Notes/Recipe.md
name       Recipe
extension  md
size       1024
created    1700000000000
modified   1700001000000
```

--------------------------------

### Diff file versions

Source: https://obsidian.md/help/cli

List or compare file versions from local recovery or Sync.

```text
file=<name>          # file name
path=<path>          # file path
from=<n>             # version number to diff from
to=<n>               # version number to diff to
filter=local|sync    # filter by version source

```

```text
# List all versions of the active file
diff

# List all versions of a specific file
diff file=Recipe

# Compare the latest version to the current file
diff file=Recipe from=1

# Compare two versions
diff file=Recipe from=2 to=1

# Only show Sync versions
diff filter=sync

```

--------------------------------

### Task Listing Configuration

Source: https://obsidian.md/help/cli

Available parameters for filtering and formatting task lists.

```text
file=<name>        # filter by file name
path=<path>        # filter by file path
status="<char>"    # filter by status character

total              # return task count
done               # show completed tasks
todo               # show incomplete tasks
verbose            # group by file with line numbers
format=json|tsv|csv  # output format (default: text)
active             # show tasks for active file
daily              # show tasks from daily note
```

--------------------------------

### List bookmarks

Source: https://obsidian.md/help/cli

Parameters for the bookmarks command to configure output details and format.

```text
total              # return bookmark count
verbose            # include bookmark types
format=json|tsv|csv  # output format (default: tsv)
```

--------------------------------

### workspace

Source: https://obsidian.md/help/cli

Shows the workspace tree.

```APIDOC
## workspace

### Description
Show workspace tree.

### Parameters
- **ids** (flag) - Optional - Include workspace item IDs
```

--------------------------------

### diff

Source: https://obsidian.md/help/cli

List or compare versions from local File recovery and Sync.

```APIDOC
## diff

### Description
List or compare versions from local File recovery and Sync. Versions are numbered from newest to oldest.

### Parameters
#### Query Parameters
- **file** (string) - Optional - file name
- **path** (string) - Optional - file path
- **from** (number) - Optional - version number to diff from
- **to** (number) - Optional - version number to diff to
- **filter** (string) - Optional - filter by version source (local|sync)
```

--------------------------------

### Workspace Management Commands

Source: https://obsidian.md/help/cli

Commands for interacting with workspaces, including listing, saving, loading, and deleting.

```text
ids                # include workspace item IDs
```

```text
total              # return workspace count
```

```text
name=<name>        # workspace name
```

```text
name=<name>        # (required) workspace name
```

```text
name=<name>        # (required) workspace name
```

--------------------------------

### daily

Source: https://obsidian.md/help/cli

Open daily note.

```APIDOC
## daily

### Description
Open daily note.

### Parameters
#### Query Parameters
- **paneType** (string) - Optional - pane type to open in (tab|split|window)
```

--------------------------------

### templates

Source: https://obsidian.md/help/cli

Lists all available templates.

```APIDOC
## templates

### Description
List templates.

### Parameters
#### Query Parameters
- **total** (flag) - Optional - Return template count
```

--------------------------------

### Capture screenshot

Source: https://obsidian.md/help/cli

Takes a screenshot of the current view and saves it as a base64 PNG to the specified path.

```bash
path=<filename>    # output file path
```

--------------------------------

### Developer and debugging commands

Source: https://obsidian.md/help/cli

Specialized commands for plugin development, debugging, and automated testing.

```bash
# Open developer tools
obsidian devtools

# Reload a community plugin you're developing
obsidian plugin:reload id=my-plugin

# Take a screenshot of the app
obsidian dev:screenshot path=screenshot.png

# Run JavaScript in the app console
obsidian eval code="app.vault.getFiles().length"
```

--------------------------------

### Enable plugin command

Source: https://obsidian.md/help/cli

Enables a specific plugin by its ID.

```text
id=<id>                # (required) plugin ID
filter=core|community  # plugin type
```

--------------------------------

### List backlinks command

Source: https://obsidian.md/help/cli

Lists backlinks for a specified file or the active file.

```text
file=<name>        # target file name
path=<path>        # target file path

counts             # include link counts
total              # return backlink count
format=json|tsv|csv  # output format (default: tsv)
```

--------------------------------

### ob login

Source: https://obsidian.md/help/headless

Authenticates the user with Obsidian services. If credentials are omitted, the command prompts for them interactively.

```APIDOC
## ob login

### Description
Logs the user into Obsidian services. Displays account info if already logged in.

### Usage
`ob login [--email <email>] [--password <password>] [--mfa <code>]`

### Parameters
- **--email** (string) - Optional - The account email address.
- **--password** (string) - Optional - The account password.
- **--mfa** (string) - Optional - The 2FA code if enabled on the account.
```

--------------------------------

### Manually Copy Linux CLI Binary

Source: https://obsidian.md/help/cli

Manually copy and set permissions for the CLI binary if it is missing.

```bash
cp /path/to/Obsidian/obsidian-cli ~/.local/bin/obsidian
chmod 755 ~/.local/bin/obsidian
```

--------------------------------

### Add Local Bin to PATH on Linux

Source: https://obsidian.md/help/cli

Ensure the local binary directory is included in the user's PATH variable.

```bash
export PATH="$PATH:$HOME/.local/bin"
```

--------------------------------

### Prepend content to a file

Source: https://obsidian.md/help/cli

Prepends text to a file after the frontmatter.

```text
file=<name>        # file name
path=<path>        # file path
content=<text>     # (required) content to prepend

inline             # prepend without newline
```

--------------------------------

### theme

Source: https://obsidian.md/help/cli

Shows the active theme or retrieves details for a specific theme.

```APIDOC
## theme

### Description
Show active theme or get info.

### Parameters
#### Query Parameters
- **name** (string) - Optional - Theme name for details
```

--------------------------------

### Create a note with flags

Source: https://obsidian.md/help/cli

Uses boolean flags to modify command behavior.

```bash
# Create a note and open it
obsidian create name=Note content="Hello" open overwrite
```

--------------------------------

### Sync Version History

Source: https://obsidian.md/help/cli

Commands to list version history for a specific file or retrieve the total version count.

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

total              # return version count
```

--------------------------------

### Web Viewer Command

Source: https://obsidian.md/help/cli

Command to open a URL in the web viewer.

```text
url=<url>          # (required) URL to open

newtab             # open in new tab
```

--------------------------------

### workspace:save

Source: https://obsidian.md/help/cli

Saves the current layout as a workspace.

```APIDOC
## workspace:save

### Description
Save current layout as workspace.

### Parameters
- **name** (string) - Optional - Workspace name
```

--------------------------------

### snippet:enable

Source: https://obsidian.md/help/cli

Enables a CSS snippet.

```APIDOC
## snippet:enable

### Description
Enable a CSS snippet.

### Parameters
#### Query Parameters
- **name** (string) - Required - Snippet name
```

--------------------------------

### folder

Source: https://obsidian.md/help/cli

Show information about a specific folder.

```APIDOC
## folder

### Description
Show folder info.

### Parameters
- **path** (string) - Required - folder path
- **info** (string) - Optional - return specific info only (files|folders|size)
```

--------------------------------

### web

Source: https://obsidian.md/help/cli

Opens a URL in the web viewer.

```APIDOC
## web

### Description
Open URL in web viewer.

### Parameters
- **url** (string) - Required - URL to open
- **newtab** (flag) - Optional - Open in new tab
```

--------------------------------

### Publish files

Source: https://obsidian.md/help/cli

Publishes a specific file or all changed files.

```text
file=<name>        # file name
path=<path>        # file path

changed            # publish all changed files
```

--------------------------------

### history:open

Source: https://obsidian.md/help/cli

Open file recovery.

```APIDOC
## history:open

### Description
Open file recovery.

### Parameters
#### Query Parameters
- **file** (string) - Optional - file name
- **path** (string) - Optional - file path
```

--------------------------------

### Bookmark Commands

Source: https://obsidian.md/help/cli

Commands for managing bookmarks within the vault.

```APIDOC
## bookmarks
List bookmarks.

### Parameters
- **total** (flag) - Optional - return bookmark count
- **verbose** (flag) - Optional - include bookmark types
- **format** (string) - Optional - output format (json|tsv|csv)

## bookmark
Add a bookmark.

### Parameters
- **file** (string) - Optional - file to bookmark
- **subpath** (string) - Optional - subpath within file
- **folder** (string) - Optional - folder to bookmark
- **search** (string) - Optional - search query to bookmark
- **url** (string) - Optional - URL to bookmark
- **title** (string) - Optional - bookmark title
```

--------------------------------

### List file history

Source: https://obsidian.md/help/cli

List versions from File recovery for a specific file.

```text
file=<name>        # file name
path=<path>        # file path

```

--------------------------------

### dev:screenshot

Source: https://obsidian.md/help/cli

Captures a screenshot and returns it as a base64 PNG.

```APIDOC
## dev:screenshot

### Description
Take a screenshot (returns base64 PNG).

### Parameters
- **path** (string) - Optional - output file path
```

--------------------------------

### dev:css

Source: https://obsidian.md/help/cli

Inspects CSS with source locations.

```APIDOC
## dev:css

### Description
Inspect CSS with source locations.

### Parameters
- **selector** (string) - Required - CSS selector
- **prop** (string) - Optional - filter by property name
```

--------------------------------

### List vault files

Source: https://obsidian.md/help/cli

Lists files in the vault with optional filtering by folder or extension.

```text
folder=<path>      # filter by folder
ext=<extension>    # filter by extension

total              # return file count
```

--------------------------------

### files

Source: https://obsidian.md/help/cli

List files in the vault with optional filtering.

```APIDOC
## files

### Description
List files in the vault.

### Parameters
- **folder** (string) - Optional - filter by folder
- **ext** (string) - Optional - filter by extension
- **total** (flag) - Optional - return file count
```

--------------------------------

### daily:append

Source: https://obsidian.md/help/cli

Append content to daily note.

```APIDOC
## daily:append

### Description
Append content to daily note.

### Parameters
#### Query Parameters
- **content** (string) - Required - content to append
- **paneType** (string) - Optional - pane type to open in (tab|split|window)
- **inline** (boolean) - Optional - append without newline
- **open** (boolean) - Optional - open file after adding
```

--------------------------------

### Recent Files Command

Source: https://obsidian.md/help/cli

Command to list recently opened files.

```text
total              # return recent file count
```

--------------------------------

### Execute Chrome DevTools Protocol command

Source: https://obsidian.md/help/cli

Executes a specific CDP method with provided JSON parameters.

```bash
method=<CDP.method>  # (required) CDP method to call
params=<json>        # method parameters as JSON
```

--------------------------------

### List outgoing links command

Source: https://obsidian.md/help/cli

Lists outgoing links from a specified file or the active file.

```text
file=<name>        # file name
path=<path>        # file path

total              # return link count
```

--------------------------------

### Task Update Configuration

Source: https://obsidian.md/help/cli

Available parameters for referencing and modifying individual tasks.

```text
ref=<path:line>    # task reference (path:line)
file=<name>        # file name
path=<path>        # file path
line=<n>           # line number
status="<char>"    # set status character

toggle             # toggle task status
daily              # daily note
done               # mark as done
todo               # mark as todo
```

--------------------------------

### property:set

Source: https://obsidian.md/help/cli

Sets a property value on a file.

```APIDOC
## property:set

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

### Parameters
- **name** (string) - Required - property name
- **value** (string) - Required - property value
- **type** (string) - Optional - property type (text|list|number|checkbox|date|datetime)
- **file** (string) - Optional - file name
- **path** (string) - Optional - file path
```

--------------------------------

### Toggle mobile emulation

Source: https://obsidian.md/help/cli

Enables or disables mobile device emulation mode.

```bash
on                 # enable mobile emulation
off                # disable mobile emulation
```

--------------------------------

### List publish changes

Source: https://obsidian.md/help/cli

Displays status of changes including new, modified, or deleted files.

```text
total              # return change count
new                # show new files only
changed            # show changed files only
deleted            # show deleted files only
```

--------------------------------

### Verify Linux CLI Binary

Source: https://obsidian.md/help/cli

Check if the Obsidian CLI binary exists in the local bin directory.

```bash
ls -l ~/.local/bin/obsidian
```

--------------------------------

### Target a specific file

Source: https://obsidian.md/help/cli

Uses file name resolution or exact path to target a file.

```bash
# These are equivalent if "Recipe.md" is the only file with that name
obsidian read file=Recipe
obsidian read path="Templates/Recipe.md"
```

--------------------------------

### Execute JavaScript

Source: https://obsidian.md/help/cli

Runs arbitrary JavaScript code within the application and returns the result.

```bash
code=<javascript>  # (required) JavaScript code to execute
```

--------------------------------

### theme:uninstall

Source: https://obsidian.md/help/cli

Uninstalls a theme.

```APIDOC
## theme:uninstall

### Description
Uninstall a theme.

### Parameters
#### Query Parameters
- **name** (string) - Required - Theme name
```

--------------------------------

### file

Source: https://obsidian.md/help/cli

Show information about a specific file or the active file.

```APIDOC
## file

### Description
Show file info (default: active file).

### Parameters
- **file** (string) - Optional - file name
- **path** (string) - Optional - file path
```

--------------------------------

### move

Source: https://obsidian.md/help/cli

Move or rename a file.

```APIDOC
## move

### Description
Move or rename a file (default: active file).

### Parameters
- **file** (string) - Optional - file name
- **path** (string) - Optional - file path
- **to** (string) - Required - destination folder or path
```

--------------------------------

### Base Commands

Source: https://obsidian.md/help/cli

Commands for interacting with .base files within the vault.

```APIDOC
## bases
List all .base files in the vault.

## base:views
List views in the current base file.

## base:create
Create a new item in a base.

### Parameters
- **file** (string) - Optional - base file name
- **path** (string) - Optional - base file path
- **view** (string) - Optional - view name
- **name** (string) - Optional - new file name
- **content** (string) - Optional - initial content
- **open** (flag) - Optional - open file after creating
- **newtab** (flag) - Optional - open in new tab

## base:query
Query a base and return results.

### Parameters
- **file** (string) - Optional - base file name
- **path** (string) - Optional - base file path
- **view** (string) - Optional - view name to query
- **format** (string) - Optional - output format (json|csv|tsv|md|paths)
```

--------------------------------

### Execute Obsidian command

Source: https://obsidian.md/help/cli

Execute a specific command by its ID.

```text
id=<command-id>    # (required) command ID to execute

```

--------------------------------

### Enable CSS snippet

Source: https://obsidian.md/help/cli

Enables a specific CSS snippet by name.

```bash
name=<name>        # (required) snippet name
```

--------------------------------

### properties

Source: https://obsidian.md/help/cli

Lists properties in the vault or for a specific file.

```APIDOC
## properties

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

### Parameters
- **file** (string) - Optional - show properties for file
- **path** (string) - Optional - show properties for path
- **name** (string) - Optional - get specific property count
- **sort** (string) - Optional - sort by count (default: name)
- **format** (string) - Optional - output format (yaml|json|tsv) (default: yaml)
- **total** (flag) - Optional - return property count
- **counts** (flag) - Optional - include occurrence counts
- **active** (flag) - Optional - show properties for active file
```

--------------------------------

### List dead-end files command

Source: https://obsidian.md/help/cli

Lists files that have no outgoing links.

```text
total              # return dead-end count
```

--------------------------------

### List command IDs

Source: https://obsidian.md/help/cli

Use the commands command to list available command IDs, optionally filtered by a prefix.

```text
filter=<prefix>    # filter by ID prefix

```

--------------------------------

### Tab Management Commands

Source: https://obsidian.md/help/cli

Commands for listing open tabs and opening new ones.

```text
ids                # include tab IDs
```

```text
group=<id>         # tab group ID
file=<path>        # file to open
view=<type>        # view type to open
```

--------------------------------

### Insert template

Source: https://obsidian.md/help/cli

Inserts a specified template into the currently active file.

```bash
name=<template>    # (required) template name
```

--------------------------------

### recents

Source: https://obsidian.md/help/cli

Lists recently opened files.

```APIDOC
## recents

### Description
List recently opened files.

### Parameters
- **total** (flag) - Optional - Return recent file count
```

--------------------------------

### Open search view

Source: https://obsidian.md/help/cli

Opens the Obsidian search interface with an optional initial query.

```text
query=<text>       # initial search query
```

--------------------------------

### List Vault Tags

Source: https://obsidian.md/help/cli

Lists tags in the vault with options for sorting, formatting, and filtering by file.

```bash
file=<name>        # file name
path=<path>        # file path
sort=count         # sort by count (default: name)

total              # return tag count
counts             # include tag counts
format=json|tsv|csv  # output format (default: tsv)
active             # show tags for active file
```

--------------------------------

### dev:dom

Source: https://obsidian.md/help/cli

Queries DOM elements based on provided selectors and options.

```APIDOC
## dev:dom

### Description
Query DOM elements.

### Parameters
- **selector** (string) - Required - CSS selector
- **attr** (string) - Optional - get attribute value
- **css** (string) - Optional - get CSS property value
- **total** (flag) - Optional - return element count
- **text** (flag) - Optional - return text content
- **inner** (flag) - Optional - return innerHTML instead of outerHTML
- **all** (flag) - Optional - return all matches instead of first
```

--------------------------------

### append

Source: https://obsidian.md/help/cli

Append content to a file.

```APIDOC
## append

### Description
Append content to a file (default: active file).

### Parameters
- **file** (string) - Optional - file name
- **path** (string) - Optional - file path
- **content** (string) - Required - content to append
- **inline** (flag) - Optional - append without newline
```

--------------------------------

### template:insert

Source: https://obsidian.md/help/cli

Inserts a template into the active file.

```APIDOC
## template:insert

### Description
Insert template into active file.

### Parameters
#### Query Parameters
- **name** (string) - Required - Template name
```

--------------------------------

### Query a base

Source: https://obsidian.md/help/cli

Parameters for the base:query command to define the target base and output format.

```text
file=<name>                    # base file name
path=<path>                    # base file path
view=<name>                    # view name to query
format=json|csv|tsv|md|paths   # output format (default: json)
```

--------------------------------

### Open daily note

Source: https://obsidian.md/help/cli

Open the daily note in a specified pane type.

```text
paneType=tab|split|window    # pane type to open in

```

--------------------------------

### history

Source: https://obsidian.md/help/cli

List versions from File recovery only.

```APIDOC
## history

### Description
List versions from File recovery only.

### Parameters
#### Query Parameters
- **file** (string) - Optional - file name
- **path** (string) - Optional - file path
```

--------------------------------

### tasks

Source: https://obsidian.md/help/cli

Lists tasks in the vault with support for filtering by file, path, status, or specific categories like daily notes.

```APIDOC
## tasks

### Description
List tasks in the vault. Use filters to narrow down results by file, path, or status.

### Parameters
- **file** (string) - Optional - Filter by file name
- **path** (string) - Optional - Filter by file path
- **status** (string) - Optional - Filter by status character
- **total** (flag) - Optional - Return task count
- **done** (flag) - Optional - Show completed tasks
- **todo** (flag) - Optional - Show incomplete tasks
- **verbose** (flag) - Optional - Group by file with line numbers
- **format** (string) - Optional - Output format (json, tsv, csv)
- **active** (flag) - Optional - Show tasks for active file
- **daily** (flag) - Optional - Show tasks from daily note
```

--------------------------------

### workspaces

Source: https://obsidian.md/help/cli

Lists saved workspaces.

```APIDOC
## workspaces

### Description
List saved workspaces.

### Parameters
- **total** (flag) - Optional - Return workspace count
```

--------------------------------

### Read template content

Source: https://obsidian.md/help/cli

Reads a specific template by name, with optional variable resolution.

```bash
name=<template>    # (required) template name
title=<title>      # title for variable resolution

resolve            # resolve template variables
```

--------------------------------

### folders

Source: https://obsidian.md/help/cli

List folders in the vault.

```APIDOC
## folders

### Description
List folders in the vault.

### Parameters
- **folder** (string) - Optional - filter by parent folder
- **total** (flag) - Optional - return folder count
```

--------------------------------

### orphans

Source: https://obsidian.md/help/cli

List files with no incoming links.

```APIDOC
## orphans

### Description
List files with no incoming links.

### Parameters
- **total** (flag) - Optional - return orphan count
```

--------------------------------

### Everyday vault management commands

Source: https://obsidian.md/help/cli

Common operations for daily notes, searching, and file manipulation within an Obsidian vault.

```bash
# Open today's daily note
obsidian daily

# Add a task to your daily note
obsidian daily:append content="- [ ] Buy groceries"

# Search your vault
obsidian search query="meeting notes"

# Read the active file
obsidian read

# List all tasks from your daily note
obsidian tasks daily

# Create a new note from a template
obsidian create name="Trip to Paris" template=Travel

# List all tags in your vault with counts
obsidian tags counts

# Compare two versions of a file
obsidian diff file=README from=1 to=3
```

--------------------------------

### history:restore

Source: https://obsidian.md/help/cli

Restore a local history version.

```APIDOC
## history:restore

### Description
Restore a local history version.

### Parameters
#### Query Parameters
- **file** (string) - Optional - file name
- **path** (string) - Optional - file path
- **version** (number) - Required - version number
```

--------------------------------

### Copy command output to clipboard

Source: https://obsidian.md/help/cli

Appends the --copy flag to pipe command output to the system clipboard.

```bash
read --copy
search query="TODO" --copy
```

--------------------------------

### plugins:restrict

Source: https://obsidian.md/help/cli

Toggle or check restricted mode.

```APIDOC
## plugins:restrict

### Description
Toggle or check restricted mode.

### Parameters
- **on** (flag) - Optional - enable restricted mode
- **off** (flag) - Optional - disable restricted mode
```

--------------------------------

### dev:cdp

Source: https://obsidian.md/help/cli

Executes a Chrome DevTools Protocol command.

```APIDOC
## dev:cdp

### Description
Run a Chrome DevTools Protocol command.

### Parameters
- **method** (string) - Required - CDP method to call
- **params** (json) - Optional - method parameters as JSON
```

--------------------------------

### List unresolved links command

Source: https://obsidian.md/help/cli

Lists all unresolved links within the vault.

```text
total              # return unresolved link count
counts             # include link counts
verbose            # include source files
format=json|tsv|csv  # output format (default: tsv)
```

--------------------------------

### history:read

Source: https://obsidian.md/help/cli

Read a local history version.

```APIDOC
## history:read

### Description
Read a local history version.

### Parameters
#### Query Parameters
- **file** (string) - Optional - file name
- **path** (string) - Optional - file path
- **version** (number) - Optional - version number (default: 1)
```

--------------------------------

### unique

Source: https://obsidian.md/help/cli

Creates a unique note.

```APIDOC
## unique

### Description
Create unique note.

### Parameters
#### Query Parameters
- **name** (string) - Optional - Note name
- **content** (string) - Optional - Initial content
- **paneType** (string) - Optional - Pane type to open in (tab|split|window)
- **open** (flag) - Optional - Open file after creating
```

--------------------------------

### task

Source: https://obsidian.md/help/cli

Shows or updates a specific task identified by reference, file, or line number.

```APIDOC
## task

### Description
Show or update a specific task. Supports toggling status or setting specific status characters.

### Parameters
- **ref** (string) - Optional - Task reference (path:line)
- **file** (string) - Optional - File name
- **path** (string) - Optional - File path
- **line** (integer) - Optional - Line number
- **status** (string) - Optional - Set status character
- **toggle** (flag) - Optional - Toggle task status
- **daily** (flag) - Optional - Target daily note
- **done** (flag) - Optional - Mark as done
- **todo** (flag) - Optional - Mark as todo
```

--------------------------------

### links

Source: https://obsidian.md/help/cli

List outgoing links from a file.

```APIDOC
## links

### Description
List outgoing links from a file (default: active file).

### Parameters
- **file** (string) - Optional - file name
- **path** (string) - Optional - file path
- **total** (flag) - Optional - return link count
```

--------------------------------

### read

Source: https://obsidian.md/help/cli

Read file contents.

```APIDOC
## read

### Description
Read file contents (default: active file).

### Parameters
- **file** (string) - Optional - file name
- **path** (string) - Optional - file path
```

--------------------------------

### vault:open

Source: https://obsidian.md/help/cli

Switches to a different vault (TUI only).

```APIDOC
## vault:open

### Description
Switch to a different vault (TUI only).

### Parameters
- **name** (string) - Required - Vault name
```

--------------------------------

### Verify macOS CLI Symlink

Source: https://obsidian.md/help/cli

Check if the Obsidian CLI symlink exists and points to the correct binary on macOS.

```bash
ls -l /usr/local/bin/obsidian
```

--------------------------------

### Use the interactive TUI

Source: https://obsidian.md/help/cli

Launches the terminal user interface for interactive command entry and history navigation.

```bash
# Open the TUI, then run help
obsidian
help
```

--------------------------------

### rename

Source: https://obsidian.md/help/cli

Rename a file.

```APIDOC
## rename

### Description
Rename a file (default: active file).

### Parameters
- **file** (string) - Optional - file name
- **path** (string) - Optional - file path
- **name** (string) - Required - new file name
```

--------------------------------

### List Deleted Sync Files

Source: https://obsidian.md/help/cli

Lists files deleted in sync, with an option to return the total count.

```bash
total              # return deleted file count
```

--------------------------------

### Inspect CSS properties

Source: https://obsidian.md/help/cli

Inspects CSS styles for a given selector, with an optional property filter.

```bash
selector=<css>     # (required) CSS selector
prop=<name>        # filter by property name
```

--------------------------------

### dev:console

Source: https://obsidian.md/help/cli

Displays captured console messages with optional filtering.

```APIDOC
## dev:console

### Description
Show captured console messages.

### Parameters
- **limit** (integer) - Optional - max messages to show (default 50)
- **level** (string) - Optional - filter by log level (log|warn|error|info|debug)
- **clear** (flag) - Optional - clear the console buffer
```

--------------------------------

### Remove property command options

Source: https://obsidian.md/help/cli

Parameters for removing a specific property from a file.

```text
name=<name>        # (required) property name
file=<name>        # file name
path=<path>        # file path
```

--------------------------------

### template:read

Source: https://obsidian.md/help/cli

Reads the content of a specific template.

```APIDOC
## template:read

### Description
Read template content.

### Parameters
#### Query Parameters
- **name** (string) - Required - Template name
- **title** (string) - Optional - Title for variable resolution
- **resolve** (flag) - Optional - Resolve template variables
```

--------------------------------

### unresolved

Source: https://obsidian.md/help/cli

List unresolved links in vault.

```APIDOC
## unresolved

### Description
List unresolved links in vault.

### Parameters
- **total** (flag) - Optional - return unresolved link count
- **counts** (flag) - Optional - include link counts
- **verbose** (flag) - Optional - include source files
- **format** (string) - Optional - output format (json|tsv|csv, default: tsv)
```

--------------------------------

### backlinks

Source: https://obsidian.md/help/cli

List backlinks to a file.

```APIDOC
## backlinks

### Description
List backlinks to a file (default: active file).

### Parameters
- **file** (string) - Optional - target file name
- **path** (string) - Optional - target file path
- **counts** (flag) - Optional - include link counts
- **total** (flag) - Optional - return backlink count
- **format** (string) - Optional - output format (json|tsv|csv, default: tsv)
```

--------------------------------

### Rename a file

Source: https://obsidian.md/help/cli

Renames a file while preserving the extension.

```text
file=<name>        # file name
path=<path>        # file path
name=<name>        # (required) new file name
```

--------------------------------

### aliases

Source: https://obsidian.md/help/cli

Lists aliases in the vault or for a specific file.

```APIDOC
## aliases

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

### Parameters
- **file** (string) - Optional - file name
- **path** (string) - Optional - file path
- **total** (flag) - Optional - return alias count
- **verbose** (flag) - Optional - include file paths
- **active** (flag) - Optional - show aliases for active file
```
Tokens:
Raw