From 94cccc0f8fb3dd3de74a441c0a9e3e30e09f5b2c Mon Sep 17 00:00:00 2001 From: yacosta738 <33158051+yacosta738@users.noreply.github.com> Date: Sat, 5 Sep 2026 04:24:29 +0000 Subject: [PATCH] docs: update CLI and configuration reference documentation - Add missing `-p, --project-root` global option and `--json` subcommand flags for `agentsync plugin` in `reference/cli.mdx`. - Alphabetize Agent Compatibility Matrix table in `reference/configuration.mdx` and move inline Cursor note below the table to fix table structure. --- .../docs/src/content/docs/reference/cli.mdx | 18 ++++++++ .../content/docs/reference/configuration.mdx | 44 +++++++++---------- 2 files changed, 40 insertions(+), 22 deletions(-) diff --git a/website/docs/src/content/docs/reference/cli.mdx b/website/docs/src/content/docs/reference/cli.mdx index ee69ab49..3e02caef 100644 --- a/website/docs/src/content/docs/reference/cli.mdx +++ b/website/docs/src/content/docs/reference/cli.mdx @@ -329,6 +329,9 @@ Manage repository-owned, vendor-neutral plugin materialization. agentsync plugin [OPTIONS] ``` +**Global Options**: +- `-p, --project-root `: Root of the project (defaults to CWD). + The project must declare the marketplace in `.agents/agentsync.toml`; `add` and `update` persist the selected plugin in that file if it is not already present. @@ -341,6 +344,9 @@ Resolve the configured marketplace reference, validate the selected plugin, writ agentsync plugin add [--json] ``` +**Options**: +- `--json`: Output machine-readable JSON. + This is an explicit network-capable operation for Git sources. Local sources remain offline. Git sources are snapshotted into AgentSync-owned project state so later `apply`, `status`, and `dry-run` operations remain offline. @@ -354,6 +360,9 @@ This is also the only operation, besides `add`, that may refresh a Git source sn agentsync plugin update [--json] ``` +**Options**: +- `--json`: Output machine-readable JSON. + #### `list` List locked plugins and their revisions without changing files. @@ -362,6 +371,9 @@ List locked plugins and their revisions without changing files. agentsync plugin list [--json] ``` +**Options**: +- `--json`: Output machine-readable JSON. + #### `status` Validate locked source content and report drift without materializing or executing anything. @@ -370,6 +382,9 @@ Validate locked source content and report drift without materializing or executi agentsync plugin status [--json] ``` +**Options**: +- `--json`: Output machine-readable JSON. + #### `remove` Remove only skills recorded as owned by the selected plugin, remove its lock entry, and remove the @@ -379,6 +394,9 @@ matching selection from `agentsync.toml`. agentsync plugin remove [--json] ``` +**Options**: +- `--json`: Output machine-readable JSON. + Plugin MCP declarations are generated by the normal `agentsync apply` flow. They are namespaced as `plugin///` and are never started by AgentSync. diff --git a/website/docs/src/content/docs/reference/configuration.mdx b/website/docs/src/content/docs/reference/configuration.mdx index 0d3593b9..1ff83be7 100644 --- a/website/docs/src/content/docs/reference/configuration.mdx +++ b/website/docs/src/content/docs/reference/configuration.mdx @@ -246,41 +246,41 @@ The matrix below documents common agent locations and whether AgentSync can hand | Agent | Rules File(s) | MCP Configuration / Notes | Skills Support / Location | | :--- | :--- | :--- | :--- | | AGENTS.md | `AGENTS.md` | Pseudo-agent pattern via `[agents.root]` target | - | -| GitHub Copilot | `.github/copilot-instructions.md` | `.vscode/mcp.json` (native MCP) | Configurable | +| Aider | - | No native MCP formatter; `.aider.conf.yml`, `.aiderignore` ignores | Configurable | +| Amazon Q CLI | - | No native MCP formatter; `.amazonq/rules/`, `.amazonq/mcp.json` ignores | Configurable | +| Amp | `AMPCODE.md` | No native MCP formatter | Configurable | +| Antigravity | - | No native MCP formatter; `.agent/rules/`, `.agent/skills/` ignores | Configurable | +| AugmentCode | - | No native MCP formatter; `.augment/rules/` ignore | Configurable | | Claude Code | `CLAUDE.md` | `.mcp.json` (native MCP) | Configurable; `.claude/skills/` | | Claude Desktop | - | Global config (native MCP); disabled by default | - | -| OpenAI Codex CLI | `AGENTS.md` | `.codex/config.toml` (native MCP) | Configurable; `.codex/skills/` | -| VS Code | - | `.vscode/mcp.json` (native MCP) | Configurable | -| Pi Coding Agent | - | No native MCP formatter | Configurable | -| Jules | - | No native MCP formatter | Configurable | -| Cursor | `.cursor/rules/agentsync.mdc` | `.cursor/mcp.json` (native MCP) | Configurable; `.cursor/skills/` | -| Windsurf | `.windsurfrules` | No native MCP formatter; `.windsurf/mcp_config.json` ignore | Configurable | | Cline | `.clinerules` | No native MCP formatter | Configurable | | Crush | `CRUSH.md` | No native MCP formatter; `.crush.json` ignore | Configurable | -| Amp | `AMPCODE.md` | No native MCP formatter | Configurable | -| Antigravity | - | No native MCP formatter; `.agent/rules/`, `.agent/skills/` ignores | Configurable | -| Amazon Q CLI | - | No native MCP formatter; `.amazonq/rules/`, `.amazonq/mcp.json` ignores | Configurable | -| Aider | - | No native MCP formatter; `.aider.conf.yml`, `.aiderignore` ignores | Configurable | +| Cursor | `.cursor/rules/agentsync.mdc` | `.cursor/mcp.json` (native MCP) | Configurable; `.cursor/skills/` | +| Factory Droid | - | No native MCP formatter; `.factory/mcp.json`, `.factory/skills/` ignores | Configurable | | Firebase Studio | - | No native MCP formatter; `.idx/airules.md`, `.idx/mcp.json` ignores | Configurable | -| Open Hands | - | No native MCP formatter; `.openhands/microagents/` ignore | Configurable | - -**Note (Cursor rules filename):** `.cursor/rules/agentsync.mdc` is the documented example path used by AgentSync for Cursor rules. You may use a different `.mdc` filename/path if you configure it explicitly under your `[agents..targets.*]` entries. +| Firebender | - | No native MCP formatter; `firebender.json` ignore | Configurable | | Gemini CLI | `GEMINI.md` | `.gemini/settings.json` (native MCP, adds `"trust": true`) | Configurable; `.gemini/skills/` | +| GitHub Copilot | `.github/copilot-instructions.md` | `.vscode/mcp.json` (native MCP) | Configurable | +| Goose | - | No native MCP formatter; `.goosehints` ignore | Configurable | +| JetBrains AI Assistant | - | No native MCP formatter; `.aiassistant/rules/` ignore | Configurable | +| Jules | - | No native MCP formatter | Configurable | | Junie | - | No native MCP formatter; `.junie/` ignore | Configurable | -| AugmentCode | - | No native MCP formatter; `.augment/rules/` ignore | Configurable | | Kilo Code | - | No native MCP formatter; `.kilocode/mcp.json` ignore | Configurable | +| Kiro | - | No native MCP formatter; `.kiro/steering/`, `.kiro/settings/mcp.json` ignores | Configurable | +| Mistral Vibe | - | No native MCP formatter; `.vibe/config.toml`, `.vibe/skills/` ignores | Configurable | +| Open Hands | - | No native MCP formatter; `.openhands/microagents/` ignore | Configurable | +| OpenAI Codex CLI | `AGENTS.md` | `.codex/config.toml` (native MCP) | Configurable; `.codex/skills/` | | OpenCode | `AGENTS.md` | `opencode.json` (native MCP) | Configurable; `.opencode/skills/` | -| Goose | - | No native MCP formatter; `.goosehints` ignore | Configurable | +| Pi Coding Agent | - | No native MCP formatter | Configurable | | Qwen Code | - | No native MCP formatter; `.qwen/settings.json` ignore | Configurable | | RooCode | - | No native MCP formatter; `.roo/mcp.json`, `.roo/rules/`, `.roo/skills/` ignores | Configurable | -| Zed | - | No native MCP formatter; `.zed/settings.json` ignore | Configurable | | Trae AI | - | No native MCP formatter; `.trae/rules/` ignore | Configurable | +| VS Code | - | `.vscode/mcp.json` (native MCP) | Configurable | | Warp | `WARP.md` | No native MCP formatter | Configurable | -| Kiro | - | No native MCP formatter; `.kiro/steering/`, `.kiro/settings/mcp.json` ignores | Configurable | -| Firebender | - | No native MCP formatter; `firebender.json` ignore | Configurable | -| Factory Droid | - | No native MCP formatter; `.factory/mcp.json`, `.factory/skills/` ignores | Configurable | -| Mistral Vibe | - | No native MCP formatter; `.vibe/config.toml`, `.vibe/skills/` ignores | Configurable | -| JetBrains AI Assistant | - | No native MCP formatter; `.aiassistant/rules/` ignore | Configurable | +| Windsurf | `.windsurfrules` | No native MCP formatter; `.windsurf/mcp_config.json` ignore | Configurable | +| Zed | - | No native MCP formatter; `.zed/settings.json` ignore | Configurable | + +**Note (Cursor rules filename):** `.cursor/rules/agentsync.mdc` is the documented example path used by AgentSync for Cursor rules. You may use a different `.mdc` filename/path if you configure it explicitly under your `[agents..targets.*]` entries. ### What "configurable" means in practice