Obsidian Helper#

A command-line tool for operating Obsidian vaults. Works with vaults stored on Windows (WSL) or Linux.

Installation#

Quick Install (Recommended)#

Run the install script:

bash

cd ~/skills/obsidian-helper
bash scripts/install.sh

This will:

• Copy obsidian script to ~/bin/
• Make it executable
• Add ~/bin to your PATH (if not already present)

Verify Installation#

bash

which obsidian
obsidian --version  # or obsidian help

Quick Start#

bash

obsidian list              # 列出所有笔记
obsidian search 关键词      # 搜索笔记内容
obsidian create 文件名      # 创建新笔记
obsidian read 文件名        # 读取笔记
obsidian edit 文件名        # 编辑笔记 (vim)
obsidian daily             # 创建/查看日报
obsidian delete 文件名      # 删除笔记

Configuration#

The script auto-detects the vault path:

1. Environment variable (highest priority): bash

   export OBSIDIAN_VAULT=/path/to/your/vault
   
   

2. WSL environment: Auto-detects Windows user directory text

   /mnt/c/Users/<WindowsUser>/Documents/Obsidian
   
   

3. Linux environment: Uses default path text

   ~/obsidian
   
   

4. Set your Obsidian vault path (optional - auto-detects if not set): bash

   # Add to ~/.bashrc
   echo 'export OBSIDIAN_VAULT=/mnt/c/Users/YourName/Documents/Obsidian/Vault' >> ~/.bashrc
   source ~/.bashrc
   
   

Commands Reference#

CommandAliasesDescriptionlist``ls, lList all markdown notes in vaultsearch <term>``s, findSearch content in notescreate <name> [content]``c, newCreate new noteread <name>``r, cat, showRead note contentedit <name>``e, vimEdit note in vimdaily [date]``d, todayCreate/view daily notedelete <name>``del, rmDelete a notehelp``hShow help

Examples#

bash

# List all notes
obsidian list

# Search for "project"
obsidian search project

# Create a note in a folder
obsidian create "Projects/MyProject"

# Create with content
obsidian create "Ideas/Quick Note" "# Quick Note\n\nThis is my idea."

# Read a note
obsidian read "Welcome"

# Create today's daily note
obsidian daily

Daily Notes#

Daily notes are stored in Daily/YYYY/YYYY-MM-DD.md format.