Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ behavior to the `volcano` CLI — plugins do not reimplement Volcano features.
| Host | Path | Format | Notes |
| --- | --- | --- | --- |
| VS Code-family editors | [`plugins/vscode`](./plugins/vscode) | VSIX extension | For VS Code, Open VSX, Windsurf, and other VSIX-compatible editors. Cursor is not a VSIX host. |
| Cursor | [`plugins/cursor`](./plugins/cursor) | Cursor plugin | Uses `.cursor-plugin/plugin.json`, rules, commands, and materialized `skills/`. |
| Cursor | [`plugins/cursor`](./plugins/cursor) | Cursor plugin | Install [Volcano from Cursor Marketplace](https://cursor.com/marketplace/kong/volcano) (recommended). See the [installation instructions](./plugins/cursor/README.md#install-from-cursor-marketplace) or [optional manual installation](./plugins/cursor/README.md#manual-installation-optional). |
| Claude Code | [`plugins/claude-code`](./plugins/claude-code) | Claude Code plugin | Uses `.claude-plugin/plugin.json`; repo marketplace index is [`./.claude-plugin/marketplace.json`](./.claude-plugin/marketplace.json). |
| Claude Desktop | [`plugins/claude-desktop`](./plugins/claude-desktop) | MCP Bundle / Desktop Extension | Provides setup and instruction tools; not the full Volcano MCP action surface. |
| Codex | [`plugins/codex`](./plugins/codex) | Codex plugin | Repo marketplace index is [`./.agents/plugins/marketplace.json`](./.agents/plugins/marketplace.json). |
Expand Down
45 changes: 20 additions & 25 deletions plugins/cursor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,17 @@ The plugin also includes:

There is intentionally **no MCP config yet**; Volcano does not currently ship MCP.

## Install from Cursor Marketplace

Install [Volcano](https://cursor.com/marketplace/kong/volcano) from Cursor Marketplace (recommended):

1. Open **Customize** in Cursor's sidebar.
2. Search for **Volcano** and select the plugin published by **Kong**.
3. Select **Install** and choose a project or user scope.
4. Run `/install-volcano` in Cursor's Agent chat to set up the CLI through the bundled setup skill. It reuses a working CLI without automatic upgrades.

Marketplace installation does not require a repository clone, shell installer, or VSIX file.

## Components

| Path | Purpose |
Expand All @@ -39,38 +50,23 @@ pnpm check:skill-drift
pnpm check:no-content-duplicates
```

## Install locally (manual path)
## Manual installation (optional)

Cursor has no global `AGENTS.md`/rules file, so the host-agnostic bootstrap
installer can only leave a *project-scoped* rule for Cursor. Installing the
plugin into Cursor's local plugins directory instead gives the full, native
experience across every project — the always-applied Volcano rule **and** the
`volcano-*` skills, just like a Marketplace install.

Run the installer (from a clone of this repo, or piped from GitHub):
For installation outside Cursor Marketplace, clone this repository and run the local installer:

```sh
git clone https://github.com/Kong/volcano-agentic-plugins.git
cd volcano-agentic-plugins
sh scripts/install-cursor-plugin.sh
# …or without a local clone:
curl -fsSL https://raw.githubusercontent.com/Kong/volcano-agentic-plugins/main/scripts/install-cursor-plugin.sh | sh
```

It copies `plugins/cursor` into `~/.cursor/plugins/local/volcano` (override the
target with `CURSOR_PLUGINS_DIR`). Restart Cursor or run **Developer: Reload
Window** afterward.

## Develop locally (symlink)
If you already have a checkout, run `sh scripts/install-cursor-plugin.sh` from its root.

For plugin development, symlink your working tree so edits are picked up on
reload. Submodules are needed only for CI drift checks, not for local loading:
The script copies `plugins/cursor` into `~/.cursor/plugins/local/volcano`. Restart Cursor or run **Developer: Reload Window**, then check the plugin in **Customize**. Local plugin imports must be allowed. Run `/install-volcano` in Agent chat to set up the CLI through the bundled setup skill. Submodules are not needed for manual installation.

```sh
mkdir -p ~/.cursor/plugins/local
rm -rf ~/.cursor/plugins/local/volcano
ln -s "$(pwd)/plugins/cursor" ~/.cursor/plugins/local/volcano # run from the repo root
```
For local development, repeat the copy and reload after editing plugin files.

Then restart Cursor or run **Developer: Reload Window**.
Do not symlink an external checkout into the local plugins directory; Cursor skips symlinks whose targets are outside that directory. See [Cursor's local plugin instructions](https://cursor.com/docs/plugins#test-plugins-locally).

## Marketplace

Expand All @@ -80,8 +76,7 @@ This repo is a multi-IDE repository. The Cursor marketplace manifest is at:
.cursor-plugin/marketplace.json
```

Cursor Marketplace / Team Marketplace auto-refresh should track this repository
and pick up changes pushed to the tracked branch.
Team marketplaces imported from GitHub can enable Auto Refresh to track repository updates. Updates to the public listing are reviewed by Cursor before publication.

## Drift caveat

Expand Down
Loading