Merge pull request #25 from JithendraNara/codex/docs-install-guidance
docs: add Cursor install guide and VS Code note
This commit is contained in:
93
.cursor-plugin/INSTALL.md
Normal file
93
.cursor-plugin/INSTALL.md
Normal file
@@ -0,0 +1,93 @@
|
|||||||
|
# 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
|
||||||
|
C:\Users\YOUR_USERNAME\.cursor\minimax-skills\skills\
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace `YOUR_USERNAME` with your Windows account name.
|
||||||
|
|
||||||
|
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
|
||||||
12
README.md
12
README.md
@@ -40,6 +40,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/`.
|
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
|
### Codex
|
||||||
|
|
||||||
@@ -63,6 +64,17 @@ ln -s ~/.minimax-skills/skills/* ~/.config/opencode/skills/
|
|||||||
|
|
||||||
Restart OpenCode to discover the skills. See [`.opencode/INSTALL.md`](.opencode/INSTALL.md) for details.
|
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
|
## Contributing
|
||||||
|
|
||||||
We welcome contributions! Before submitting a PR, please read:
|
We welcome contributions! Before submitting a PR, please read:
|
||||||
|
|||||||
12
README_zh.md
12
README_zh.md
@@ -40,6 +40,7 @@ git clone https://github.com/MiniMax-AI/skills.git ~/.cursor/minimax-skills
|
|||||||
```
|
```
|
||||||
|
|
||||||
在 Cursor 设置中将 skills 路径指向 `~/.cursor/minimax-skills/skills/`。
|
在 Cursor 设置中将 skills 路径指向 `~/.cursor/minimax-skills/skills/`。
|
||||||
|
Windows 安装与校验方式见 [`.cursor-plugin/INSTALL.md`](.cursor-plugin/INSTALL.md)。
|
||||||
|
|
||||||
### Codex
|
### Codex
|
||||||
|
|
||||||
@@ -63,6 +64,17 @@ ln -s ~/.minimax-skills/skills/* ~/.config/opencode/skills/
|
|||||||
|
|
||||||
重启 OpenCode 以发现技能。详见 [`.opencode/INSTALL.md`](.opencode/INSTALL.md)。
|
重启 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 前请阅读:
|
欢迎贡献!提交 PR 前请阅读:
|
||||||
|
|||||||
Reference in New Issue
Block a user