Reading the repo
Opening the box…
Reading the repo
Opening the box…
How to install on macOS
Run agents in Obsidian - OpenCode, Codex, Claude Code etc.
Saved setup from 11 h ago
Will it work on macOS?
docs/getting-started.mdCopilot V4 is built around Agent Chat, a desktop workspace where OpenCode, Claude Code, or Codex can read your vault, use tools, and complete multi-step work with the permissions you choose.
Agent Chat is available in Obsidian on desktop. Quick Chat, Copilot Commands, and Quick Ask remain available for shorter tasks and on mobile.
Open Settings → Copilot → Basic and find Agents. For most people, the quickest path is the managed OpenCode setup.
opencode binary and manages it for you.Already have the opencode binary? Open Configure, choose My own installation, then select Auto-detect or enter its absolute path and click Apply.
If Claude Code is already installed, Copilot checks its common install locations automatically and marks Claude as installed. If it is not found:
claude binary.Claude uses the account held by the Claude Code CLI. You do not paste that account's key into Copilot.
Copilot connects to Codex through the codex-acp adapter, which includes a compatible Codex CLI:
If your adapter is below the supported minimum, open Configure in Settings to manage the installation. Agent Chat also offers Upgrade, with shared progress and errors. You can also choose Sign in to Codex on the Agent Chat status card. For terminal login, run your configured adapter with cli login using the same CODEX_HOME as Copilot.
For manual installations, Copilot requires a supported @agentclientprotocol/codex-acp adapter and checks compatibility in Configure. See Codex installation details. Codex uses the login stored by the bundled Codex CLI; there is no Codex key to paste into Copilot.
Try a concrete first request such as: “Review the unfinished tasks in this vault and make a short plan.” With Default selected, Agent Chat shows its work and asks before actions that need your approval.
From Agent Chat Home, open Projects and select New project. A project keeps its own instructions, reusable context, and chat history, so work for one client or topic stays together. See Projects for supported context sources and setup.
Skills are reusable instruction packets for jobs such as reviewing a change or drafting a release note. Open Settings → Copilot → Skills to see skills from Copilot's shared skills folder and the native OpenCode, Claude, and Codex skill folders. Enable each skill for the agents that should use it; Copilot links shared skills into the right agent folders for you.
Type / in Agent Chat to choose an available skill. Copilot also includes skills for Obsidian Markdown, Bases, and Canvas. Learn more in Skills across agents.
Create preset prompts under Settings → Copilot → Command. Run them from the command palette, the editor's Copilot menu, or by typing / in Agent Chat. See Copilot Commands and Quick Ask.
Run Quick Ask from the command palette, or assign it a hotkey under Obsidian Settings → Hotkeys. It opens a small prompt beside your cursor or selection for quick rewrites, explanations, and follow-up questions. Quick Ask uses your Quick Chat model, so set up a Copilot-hosted or BYOK model first.
Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Needs Git: xcode-select --install
git clone https://github.com/logancyang/obsidian-copilot.git cd obsidian-copilot
Node.js 22.x
# needs nvm: brew install nvm (or https://github.com/nvm-sh/nvm) nvm install 22
npm ci
npm run dev
npm test
The Getting Started guide covers each setup path, including managed and custom Codex adapters.
No reports for macOS yet.
GitManual AI Agent reads the 8 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.