From 6c404106e339a2839a2091f477a170e8f411137d Mon Sep 17 00:00:00 2001 From: JithendraNara Date: Wed, 25 Mar 2026 13:53:04 -0400 Subject: [PATCH] docs: add Cursor install guide and VS Code note --- .cursor-plugin/INSTALL.md | 91 +++++++++++++++++++++++++++++++++++++++ README.md | 12 ++++++ README_zh.md | 12 ++++++ 3 files changed, 115 insertions(+) create mode 100644 .cursor-plugin/INSTALL.md diff --git a/.cursor-plugin/INSTALL.md b/.cursor-plugin/INSTALL.md new file mode 100644 index 0000000..08324ee --- /dev/null +++ b/.cursor-plugin/INSTALL.md @@ -0,0 +1,91 @@ +# Installing MiniMax Skills for Cursor + +Enable MiniMax skills in Cursor by cloning the repository locally and pointing Cursor's skills path at the `skills/` directory. + +## Prerequisites + +- Cursor installed +- Git + +## Installation + +### macOS / Linux + +```bash +git clone https://github.com/MiniMax-AI/skills.git ~/.cursor/minimax-skills +``` + +Set Cursor's skills path to: + +```text +~/.cursor/minimax-skills/skills/ +``` + +### Windows (PowerShell) + +```powershell +git clone https://github.com/MiniMax-AI/skills.git "$env:USERPROFILE\.cursor\minimax-skills" +``` + +Set Cursor's skills path to: + +```text +%USERPROFILE%\.cursor\minimax-skills\skills\ +``` + +After saving the path, restart Cursor or reload the window so it rescans local skills. + +## Verify + +Confirm the clone exists and contains `SKILL.md` files: + +### macOS / Linux + +```bash +find ~/.cursor/minimax-skills/skills -maxdepth 2 -name SKILL.md | head +``` + +### Windows (PowerShell) + +```powershell +Get-ChildItem "$env:USERPROFILE\.cursor\minimax-skills\skills" -Directory | ForEach-Object { + Get-ChildItem $_.FullName -Filter SKILL.md +} +``` + +## Updating + +### macOS / Linux + +```bash +cd ~/.cursor/minimax-skills && git pull +``` + +### Windows (PowerShell) + +```powershell +Set-Location "$env:USERPROFILE\.cursor\minimax-skills" +git pull +``` + +## Uninstalling + +### macOS / Linux + +```bash +rm -rf ~/.cursor/minimax-skills +``` + +### Windows (PowerShell) + +```powershell +Remove-Item -Recurse -Force "$env:USERPROFILE\.cursor\minimax-skills" +``` + +## VS Code Note + +This repository does not currently ship a standalone VS Code extension. + +If you use VS Code, the recommended options are: +- run a supported CLI tool such as Codex, Claude Code, or OpenCode inside the VS Code integrated terminal +- use Cursor if you want native local-skills configuration from this repository diff --git a/README.md b/README.md index 5529e27..78ceeb2 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,7 @@ git clone https://github.com/MiniMax-AI/skills.git ~/.cursor/minimax-skills ``` Add to your Cursor settings — point the skills path to `~/.cursor/minimax-skills/skills/`. +For Windows setup and verification, see [`.cursor-plugin/INSTALL.md`](.cursor-plugin/INSTALL.md). ### Codex @@ -61,6 +62,17 @@ ln -s ~/.minimax-skills/skills/* ~/.config/opencode/skills/ Restart OpenCode to discover the skills. See [`.opencode/INSTALL.md`](.opencode/INSTALL.md) for details. +### VS Code + +This repository does not currently ship a standalone VS Code extension. + +If you use VS Code, the supported approach is to run one of the supported CLI tools inside the integrated terminal: +- Codex +- Claude Code +- OpenCode + +If you want native local-skills configuration from this repo, use Cursor and follow [`.cursor-plugin/INSTALL.md`](.cursor-plugin/INSTALL.md). + ## Contributing We welcome contributions! Before submitting a PR, please read: diff --git a/README_zh.md b/README_zh.md index 62155d1..8ba2a7b 100644 --- a/README_zh.md +++ b/README_zh.md @@ -38,6 +38,7 @@ git clone https://github.com/MiniMax-AI/skills.git ~/.cursor/minimax-skills ``` 在 Cursor 设置中将 skills 路径指向 `~/.cursor/minimax-skills/skills/`。 +Windows 安装与校验方式见 [`.cursor-plugin/INSTALL.md`](.cursor-plugin/INSTALL.md)。 ### Codex @@ -61,6 +62,17 @@ ln -s ~/.minimax-skills/skills/* ~/.config/opencode/skills/ 重启 OpenCode 以发现技能。详见 [`.opencode/INSTALL.md`](.opencode/INSTALL.md)。 +### VS Code + +当前仓库还没有提供独立的 VS Code 扩展。 + +如果你使用 VS Code,推荐方式是在集成终端里运行已支持的 CLI 工具: +- Codex +- Claude Code +- OpenCode + +如果你希望直接使用本仓库的本地 skills 配置,建议使用 Cursor,并参考 [`.cursor-plugin/INSTALL.md`](.cursor-plugin/INSTALL.md)。 + ## 贡献 欢迎贡献!提交 PR 前请阅读: