Skip to content

vbinupx/upx-cli

Repository files navigation

upx-cli

A CLI tool to manage AI editor prompts, rules, and skills from GitHub.

Features

  • 🚀 Zero dependency on npm for resources - Fetch rules, prompts, and skills directly from GitHub
  • 🔄 Multi-editor support - Works with VS Code (Copilot), Cursor, Trae, Claude Code, Windsurf, and Antigravity
  • ⚙️ Configurable source - Point to any GitHub repository as the source
  • 📦 Interactive selection - Choose exactly what you need with an intuitive interface

Installation

# Install globally with npm
npm i -g upx-cli

# Or with pnpm
pnpm add -g upx-cli

Quick Start

# 1. Configure your GitHub repository source
upx config set repo https://github.com/your-username/your-repo

# 2. List available resources
upx list

# 3. Add resources to your project
upx add

Commands

upx config

Manage upx configuration.

# View current configuration
upx config get

# Set GitHub repository URL
upx config set repo https://github.com/your-username/your-repo

# Reset to default configuration
upx config reset

upx list

List available resources from the configured repository.

# List all resources
upx list

# List specific type
upx list rules
upx list prompts
upx list skills

upx add

Add rules, prompts, or skills to your current project.

# Interactive mode (recommended)
upx add

# Specify type
upx add rules
upx add prompts
upx add skills

# Specify type and editor
upx add rules copilot
upx add prompts cursor
upx add rules trae
upx add rules claude
upx add prompts windsurf
upx add rules antigravity

# Overwrite existing files
upx add rules cursor --overwrite

Repository Structure

Your GitHub repository should follow this structure:

your-repo/
├── rules/
│   └── <rule-name>/
│       └── RULES.md      # Required: Rule content
├── prompts/
│   └── <prompt-name>/
│       └── PROMPT.md     # Required: Prompt content
└── skills/
    └── <skill-name>/
        └── SKILL.md      # Required: Skill content

Target Paths

VS Code (Copilot)

Type Target Path
Rules .github/instructions/<name>.instructions.md
Prompts .github/prompts/<name>.prompt.md
Skills .github/skills/<name>/SKILL.md

Cursor

Type Target Path
Rules .cursor/rules/<name>.md
Prompts (Commands) .cursor/commands/<name>.md
Skills .cursor/skills/<name>/SKILL.md

Trae

Type Target Path
Rules .trae/rules/<name>.md
Prompts .trae/rules/<name>.md *
Skills .trae/skills/<name>/SKILL.md

*Prompts are stored as rules because Trae does not support prompts.

Claude Code

Type Target Path
Rules CLAUDE.md
Prompts .claude/commands/<name>.md
Skills .claude/skills/<name>/SKILL.md

Windsurf

Type Target Path
Rules .windsurf/rules/<name>.md
Prompts .windsurf/prompts/<name>.md
Skills .windsurf/skills/<name>/SKILL.md

Antigravity

Type Target Path
Rules .agent/rules/<name>.md
Prompts .agent/rules/<name>.md *
Skills .agent/skills/<name>/SKILL.md

*Prompts are stored as rules because Antigravity does not support prompts/commands.

Examples

Adding Flutter rules to Cursor

$ upx add rules cursor

? Select rules to add:
  ◯ flutter
  ◯ react
  ◯ typescript

✓ Successfully installed:
  • flutter
    → .cursor/rules/flutter.md

Adding a skill to VS Code Copilot

$ upx add skills copilot

? Select skills to add:
  ◯ frontend-design
  ◯ api-testing

✓ Successfully installed:
  • frontend-design
    → .github/skills/frontend-design/SKILL.md

### Adding prompts to Trae (stored as rules)

```bash
$ upx add prompts trae

? Select prompts to add:
  ◯ git-commit
  ◯ fix-issue

✓ Successfully installed:
  • git-commit
    → .trae/rules/git-commit.md

Adding rules to Claude Code

$ upx add rules claude

? Select rules to add:
  ◯ typescript
  ◯ git

✓ Successfully installed:
  • typescript
    → CLAUDE.md

### Adding prompts to Windsurf

```bash
$ upx add prompts windsurf

? Select prompts to add:
  ◯ git-commit
  ◯ fix-issue

✓ Successfully installed:
  • git-commit
    → .windsurf/prompts/git-commit.md

### Adding prompts to Antigravity (stored as rules)

```bash
$ upx add prompts antigravity

? Select prompts to add:
  ◯ git-commit
  ◯ fix-issue

✓ Successfully installed:
  • git-commit
    → .agent/rules/git-commit.md

Adding prompts to Trae (stored as rules)

$ upx add prompts trae

? Select prompts to add:
  ◯ git-commit
  ◯ fix-issue

✓ Successfully installed:
  • git-commit
    → .trae/rules/git-commit.md

## Development

```bash
# Clone the repository
git clone https://github.com/ventupx/upx-cli.git
cd upx

# Install dependencies
pnpm install

# Build
pnpm run build

# Run locally
node dist/index.js

# Or link globally for testing
pnpm link

Skills source

Skills/MCP reference website

License

MIT

About

A CLI tool to manage AI editor prompts, rules, and skills from GitHub.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors