mirror of
https://github.com/rait-09/obsidian-agent-client.git
synced 2026-07-22 06:43:37 +00:00
8bbe40a2a3
Introduces a full documentation site under docs/ using VitePress, including configuration, custom theme, setup guides for supported agents (Claude Code, Codex, Gemini CLI, custom agents), usage instructions, FAQ, troubleshooting, and images. Updates .gitignore and .prettierignore to exclude VitePress build output and docs. Also updates package.json and eslint config for documentation support.
38 lines
1.5 KiB
Markdown
38 lines
1.5 KiB
Markdown
# Quick Start
|
|
|
|
This guide will get you chatting with an AI agent in just a few minutes.
|
|
|
|
## Step 1: Choose Your Agent
|
|
|
|
Agent Client supports multiple AI agents. Choose one to start:
|
|
|
|
| Agent | Provider | Integration |
|
|
|-------|----------|-------------|
|
|
| **[Claude Code](/agent-setup/claude-code)** | Anthropic | via [Zed's SDK adapter](https://github.com/zed-industries/claude-code-acp) |
|
|
| **[Codex](/agent-setup/codex)** | OpenAI | via [Zed's adapter](https://github.com/zed-industries/codex-acp) |
|
|
| **[Gemini CLI](/agent-setup/gemini-cli)** | Google | with `--experimental-acp` option |
|
|
| **[Custom](/agent-setup/custom-agents)** | Various | [Any ACP-compatible agent](https://agentclientprotocol.com/overview/agents) (e.g., OpenCode, Qwen Code) |
|
|
|
|
## Step 2: Install and Configure the Agent
|
|
|
|
Follow the setup guide for your chosen agent:
|
|
|
|
- [Claude Code Setup](/agent-setup/claude-code)
|
|
- [Codex Setup](/agent-setup/codex)
|
|
- [Gemini CLI Setup](/agent-setup/gemini-cli)
|
|
- [Custom Agents](/agent-setup/custom-agents)
|
|
|
|
Each guide covers installation, path configuration, and authentication.
|
|
|
|
## Step 3: Start Chatting
|
|
|
|
1. Click the **robot icon** in the left ribbon, or
|
|
2. Open the command palette (`Cmd/Ctrl + P`) and search for **"Open agent chat"**
|
|
|
|
The chat panel opens in the right sidebar. Type a message and press Enter!
|
|
|
|
## What's Next?
|
|
|
|
- Learn about [Note Mentions](/usage/mentions) to reference your notes in conversations
|
|
- Explore [Slash Commands](/usage/slash-commands) for quick actions
|
|
- Set up additional agents in [Agent Setup](/agent-setup/)
|