Skip to content

Installation

🚧 Under Review

This plugin is awaiting approval for Obsidian Community Plugins. For now, use BRAT (recommended) or manual installation.

Install the Plugin

  1. Install the BRAT plugin from the Community Plugins browser
  2. In Obsidian settings, go to Community Plugins → BRAT → Add Beta Plugin
  3. Paste this repo URL:
    https://github.com/RAIT-09/obsidian-agent-client
  4. BRAT will download the latest release and keep it auto-updated
  5. Enable Agent Client from the plugin list

Manual Installation

  1. Download the latest release files from GitHub Releases:
    • main.js
    • manifest.json
    • styles.css
  2. Create the plugin folder: VaultFolder/.obsidian/plugins/agent-client/
  3. Place the downloaded files in this folder
  4. Enable the plugin in Obsidian Settings → Community Plugins

Prerequisites

Node.js

Not always required

Node.js is needed for npm-based agents like Claude Code, Codex, and Gemini CLI. If your agent is a standalone binary, you can skip this step.

If you need Node.js:

  1. Download from nodejs.org
  2. Install the LTS version (recommended)

Find Your Node.js Path

bash
which node
# Example output: /usr/local/bin/node
cmd
where.exe node
# Example output: C:\Program Files\nodejs\node.exe

Configure Node.js Path

  1. Open Settings → Agent Client
  2. Enter the Node.js path in the Node.js path field

Next Steps

Continue to Quick Start to set up your first agent and start chatting!

Released under the Apache 2.0 License.