Up and Running in 3 Minutes

Choose the installation method that works best for you

Requirements

  • Obsidian v1.4.5 or later
  • macOS, Linux, or Windows (desktop only)
  • Claude Code CLI (required when using the Claude provider)
  • Codex CLI or Opencode (optional)

1. GitHub Release

  1. Go to the latest GitHub Release and download main.js, manifest.json, and styles.css
  2. Create a folder at <your-vault>/.obsidian/plugins/claudian/
  3. Copy the three downloaded files into that folder
  4. Open Obsidian → Settings → Community Plugins → enable Claudian

2. Using BRAT (auto-update)

  1. Install and enable BRAT from the Obsidian Community Plugins market
  2. Open BRAT settings → click Add Beta plugin
  3. Enter the repo URL: https://github.com/YishenTu/claudian, click Add Plugin
  4. Enable Claudian in Community Plugins (BRAT will notify you of new releases automatically)

3. Build from Source

  1. Clone the repo into your vault's plugins folder:
    git clone https://github.com/YishenTu/claudian.git
  2. Install dependencies: cd claudian && npm install
  3. Build: npm run build
  4. Enable Claudian in Obsidian → Settings → Community Plugins
↑