obsidian-plugin/logancyang_obsidian-copilot
1
0
Fork 0
mirror of https://github.com/logancyang/obsidian-copilot.git synced 2026-07-22 07:50:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
logancyang_obsidian-copilot/docs/index.md
Logan Yang ab96aebcd8
docs: Windows setup guide for Claude and Codex Agent Mode (#2542) 
* docs: add Windows setup guide for Claude Code Agent Mode

Windows users hit a confusing dead end: the Claude Code installer does not
add the binary to PATH, so `claude` and `where.exe claude` report
not-found even on a healthy install, leading users to think it broke. Copilot
resolves the binary by file path, not PATH, so the install is fine.

Add docs/agent-mode-windows-setup.md walking through install, sign-in,
Auto-detect / manual path, and troubleshooting, with the PATH gotcha called
out up front. Link it from docs/index.md and docs/agent-mode-and-tools.md.

Docs-only slice of logancyang/obsidian-copilot-preview#108; the in-plugin
not-found copy linking to this page is a follow-up.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* docs: don't link v4 Windows guide from the v3 agent doc

agent-mode-and-tools.md documents the v3 in-process autonomous agent (vault
tools, @vault, max-iterations), a different feature from v4 Agent Mode (the
Claude Code / Codex / OpenCode coding-agent backends). The Windows guide is
about v4, so the callout there was misplaced. Keep only the standalone
docs/index.md entry.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* docs: trim Windows guide to the exact command sequence

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* docs: add Codex Windows installer for Agent Mode

* docs: script Claude Windows Agent Mode setup

* docs: harden Codex CLI path resolution

* docs: verify Codex login before finishing setup

* docs: avoid redundant Codex login prompts

* fix: auto-detect Codex ACP on Windows

* fix: address Windows agent setup review

* fix: align Claude Windows configure modal

* fix: clarify Windows PowerShell install label

* fix: use gist Windows install helpers

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-05-31 20:53:56 -07:00

2.7 KiB
Raw Permalink Blame History

Copilot for Obsidian — Documentation

Welcome to the official documentation for Copilot for Obsidian, an AI-powered assistant plugin that brings the power of large language models directly into your note-taking workflow.

Table of Contents

Document What it covers
Getting Started Installation, first-time setup, opening the chat panel, keyboard shortcuts
Chat Interface Chat modes, sending messages, history, settings, auto-compact
LLM Providers All 16+ supported providers and how to set them up
Models and Parameters Chat models, embedding models, temperature, max tokens, and other parameters
Context and Mentions Active note context, @-mentions, URLs, tags, and the web viewer
Custom Commands Creating and using preset prompts, template variables, Quick Command, Quick Ask
Vault Search and Indexing Lexical search, semantic search, index management, exclusions
Agent Mode and Tools Autonomous agent, all 13 tools, file editing, web search
Windows Setup for Agent Mode Installing Claude Code or Codex on Windows and connecting it to Agent Mode
Projects Focused workspaces with isolated context, model, and chat history
System Prompts Customizing AI behavior with built-in and custom system prompts
Copilot Plus and Self-Host Copilot Plus features, memory system, self-host mode, Miyo
Troubleshooting and FAQ Common errors, provider-specific issues, performance, FAQ

Quick Start

  1. Install Copilot from Obsidian Community Plugins
  2. Add an API key in Settings → Copilot → Basic → API Keys
  3. Open the chat panel with the robot icon in the left ribbon
  4. Start chatting!

For a full walkthrough, see Getting Started.