From 86822458df6984900b063c196ae67673d0208afb Mon Sep 17 00:00:00 2001 From: meichuanyi <35057768+meichuanyi@users.noreply.github.com> Date: Fri, 5 Jun 2026 17:16:11 +0800 Subject: [PATCH] docs: Add FAQ section for common questions --- README.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) diff --git a/README.md b/README.md index c6bf62f..dfa1b81 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,77 @@ skillkit scan Desktop only (macOS, Windows, Linux) — reads files outside your vault. + + +--- + +## FAQ (Frequently Asked Questions) + +### What is Agentfiles? + +Agentfiles is an **AI skills manager for Obsidian** that lets you browse, create, and manage skills across Claude Code, Cursor, Codex, Windsurf, and 10+ coding agents — all from your Obsidian vault. + +### What can I do with Agentfiles? + +| Feature | Description | +|---------|-------------| +| **Browse** | Skills, commands, and agents from 13+ tools in one place | +| **Search** | By name or file content with deep search toggle | +| **Create** | New skills with a stepped wizard (pick tool, type, name) | +| **Edit** | Skills inline with markdown preview and Cmd+S save | +| **Marketplace** | Install skills from [skills.sh](https://skills.sh) | +| **Conversations** | Browse Claude Code session history, search, tag, and export | +| **Dashboard** | Usage analytics, burn rate, context tax, health metrics | + +### What tools are supported? + +| Tool | Skills | Commands | Agents | +|------|--------|----------|--------| +| Claude Code | `~/.claude/skills/` | `~/.claude/commands/` | `~/.claude/agents/` | +| Cursor | `~/.cursor/skills/` | | `~/.cursor/agents/` | +| Codex | `~/.codex/skills/` | `~/.codex/prompts/` | `~/.codex/agents/` | +| Windsurf | `~/.codeium/windsurf/memories/` | | | +| Copilot | `~/.copilot/skills/` | | | +| Amp | `~/.config/amp/skills/` | | | +| OpenCode | `~/.config/opencode/skills/` | | | +| Global | `~/.agents/skills/` | | | + +### How do I install Agentfiles? + +**From Obsidian (one-click):** +``` +obsidian://show-plugin?id=agentfiles +``` + +Or search **Agentfiles** in Settings → Community plugins inside Obsidian. + +**Manual install:** +1. Download `main.js`, `manifest.json`, and `styles.css` from the [latest release](https://github.com/Railly/agentfiles/releases/latest) +2. Create `/.obsidian/plugins/agentfiles/` +3. Copy the three files into that folder +4. Enable in Settings → Community plugins + +### What is skillkit analytics? + +Optional analytics tool for Dashboard metrics: + +```bash +npm i -g @crafter/skillkit +skillkit scan +``` + +Provides burn rate, context tax, and health metrics. + +### Is Agentfiles free and open source? + +Yes! Agentfiles is free and open source with MIT License. + +### Where can I get help? + +- 📦 [Obsidian Community](https://community.obsidian.md/plugins/agentfiles) +- 🌐 [Website](https://agentfiles.crafter.run) +- 💬 [GitHub Issues](https://github.com/Railly/agentfiles/issues) + ## License MIT