vibe-rules

[](https://www.npmjs.com/package/vibe-rules)

A powerful CLI tool for managing and sharing AI rules (prompts, configurations) across different editors and tools.

✨ Supercharge your workflow! ✨

Quick Context Guide

This guide highlights the essential parts of the codebase and how you can quickly start working with vibe-rules.

[](https://contextjson.com/futureexcited/vibe-rules)

Guide

Quickly save your favorite prompts and apply them to any supported editor:

# 1. Save your prompt locally
vibe-rules save my-react-helper -f ./prompts/react-helper.md

# 2. Apply it to Cursor
vibe-rules load my-react-helper cursor

Or, automatically install shared prompts from your project's NPM packages:

# Find packages with 'llms' exports in node_modules and install for Cursor
vibe-rules install cursor

(See full command details below.)

Installation

# Install globally (bun recommended, npm/yarn also work)
bun i -g vibe-rules

Usage

vibe-rules helps you save, list, load, and install AI rules.

Save a Rule Locally

Store a rule for later use in the common vibe-rules store (~/.vibe-rules/rules/).

# Save from a file (e.g., .mdc, .md, or plain text)
vibe-rules save my-rule-name -f ./path/to/rule-content.md

# Save directly from content string
vibe-rules save another-rule -c "This is the rule content."

# Add/update a description
vibe-rules save my-rule-name -d "A concise description of what this rule does."

Options:

• -f, --file : Path to the file containing the rule content.
• -c, --content : Rule content provided as a string. (One of -f or -c is required).
• -d, --description : An optional description for the rule.

List Saved Rules

See all the rules you've saved to the common local store.

vibe-rules list

Load (Apply) a Saved Rule to an Editor

Apply a rule _from your local store_ (~/.vibe-rules/rules/) to a specific editor's configuration file. vibe-rules handles the formatting.

# Load 'my-rule-name' for Cursor (creates/updates .cursor/rules/my-rule-name.mdc)
vibe-rules load my-rule-name cursor
# Alias: vibe-rules add my-rule-name cursor

# Load 'my-rule-name' for Claude Code IDE globally (updates ~/.claude/CLAUDE.md)
vibe-rules load my-rule-name claude-code --global
# Alias: vibe-rules add my-rule-name claude-code -g

# Load 'my-rule-name' for Windsurf (appends to ./.windsurfrules)
vibe-rules load my-rule-name windsurf

# Load into the project's unified .rules file
vibe-rules load unified my-unified-rule

# Load into a specific custom target path
vibe-rules load my-rule-name cursor -t ./my-project/.cursor-rules/custom-rule.mdc

Arguments:

• `: The name of the rule saved in the local store (~/.vibe-rules/rules/`).
• `: The target editor/tool type. Supported: cursor, windsurf, claude-code, gemini, codex, clinerules, roo, vscode`.

Options: