obsidian-cli-official

# Obsidian Official CLI

Official command-line interface for Obsidian (v1.12+). 115 commands.

## Prerequisites

- **Obsidian 1.12+** (free, public release since v1.12)
- **Obsidian must be running** (CLI connects via IPC)
- **Enable CLI**: Settings → General → Enable CLI

## Setup

Add Obsidian to PATH:

**macOS:**
```bash
export PATH="$PATH:/Applications/Obsidian.app/Contents/MacOS"
```

**Windows:**
```powershell
$env:PATH += ";$env:LOCALAPPDATA\Obsidian"
```

**Linux:**
- Snap: Already in PATH
- Flatpak: `alias obsidian='flatpak run md.obsidian.Obsidian'`
- AppImage: Move to `~/.local/bin` and `chmod +x`

**Test:** `obsidian version`

## Syntax

- **Parameters**: `name=value` or `name="value with spaces"`
- **Flags**: just the name, e.g. `open`, `overwrite`
- **Newlines**: use `\n` in content strings
- **Target vault**: `obsidian vault="My Vault" <command>` (must be first)
- **Target file**: `file=<name>` (wikilink-style) or `path=<folder/file.md>` (exact)
- **Copy output**: append `--copy` to any command

## Common Commands (with examples)

### Daily Notes
```bash
obsidian daily                                    # Open today
obsidian daily:append content="- [ ] Buy milk"    # Add to today
obsidian daily:prepend content="# Important"      # Add to top
obsidian daily:read                               # Read today's content
obsidian daily:path                               # Get daily note path
```

### Files
```bash
obsidian create name="Note" content="# Hello"     # Create note
obsidian create name="Note" template=Meeting       # Create from template
obsidian read file="Note"                          # Read note
obsidian append file="Note" content="More text"    # Append to note
obsidian prepend file="Note" content="Top text"    # Prepend to note
obsidian move file="Note" to="Archive/Note.md"     # Move note
obsidian rename file="Note" name="New Name"        # Rename note
obsidian delete file="Note"                        # Delete note
obsidian open file="Note...

# Obsidian Official CLI Skill

Complete reference for the official Obsidian CLI (v1.12+). All 115 commands documented.

## What is this?

This OpenClaw skill provides **complete access to Obsidian's official CLI** (v1.12+), enabling AI agents to:

- 📝 **Automate note-taking**: Create daily journals, meeting notes, project logs
- ✅ **Manage tasks**: Toggle task status, filter by completion, track progress
- 🔍 **Search and organize**: Find notes, create links, manage tags
- 🗄️ **Work with databases**: Query bases, create items, manage views
- 🎨 **Customize workspace**: Install themes/plugins, manage workspaces

**For OpenClaw users**: Your AI assistant can now read, write, and organize your Obsidian vault automatically.

**For developers**: Complete CLI reference with 115 commands for building Obsidian automation.

## Prerequisites

- **Obsidian 1.12+** (free, public release)
- **Platform**: macOS, Windows, or Linux
- **Obsidian must be running** (CLI connects via IPC)
- **Obsidian Publish subscription** (optional, $8/month for publish commands)

## Installation

### Via ClawHub (OpenClaw) - All Platforms

```bash
clawhub install obsidian-cli-official
```

### Via Homebrew (macOS/Linux) 🍺

```bash
# Add tap
brew tap alexanderkinging/tap

# Install
brew install obsidian-cli-official

# Test
obs help
```

### Manual Setup

#### macOS

**1. Enable CLI in Obsidian**

Settings → General → Enable CLI

**2. Add to PATH**

```bash
echo 'export PATH="$PATH:/Applications/Obsidian.app/Contents/MacOS"' >> ~/.zprofile
source ~/.zprofile
```

**3. Test**

```bash
obsidian version
obsidian vault
```

---

#### Windows

**1. Enable CLI in Obsidian**

Settings → General → Enable CLI

**2. Add to PATH**

**Option A: System Environment Variables**
1. Press `Win + X` → System → Advanced system settings
2. Environment Variables → PATH → Edit
3. Add: `C:\Users\<YourUsername>\AppData\Local\Obsidian`

**Option B: PowerShell Profile**
```powershell
# Edit profile
notepad $PROFILE

# Add...