ccmds

Markdown Documentation Search Rule

PRIORITY: Use this rule FIRST when the user asks anything about documentation, guides, references, or markdown files. This is more efficient than reading files directly.

---

Configuration

Projects using ccmds should have a .ccmdsrc configuration file in the project root. This file defines default directories, exclude patterns, and other settings.

Check if Config Exists

# View current configuration
ccmds config

# Show config file path
ccmds config --path

Create Config File (if missing)

# Create default config
ccmds init

# Create with specific directories
ccmds init -d ./docs ./api/docs

Example .ccmdsrc Configuration

{
  "documentDirectories": ["./docs", "./api/docs"],
  "exclude": ["**/node_modules/**", "**/.*/**"],
  "outputMode": "json",
  "limit": 10
}

When a config file exists, you don't need to specify directories in commands - they use the configured defaults automatically.

Named Documentation

If the project has named documentation entries in .ccmdsrc:

ccmds find "query" --doc api      # Search only "api" docs
ccmds list --doc guides           # List only "guides" docs
ccmds grep "TODO" --doc api       # Grep only in API docs

This is useful for projects with multiple doc sets (API, guides, tutorials).

---

Trigger Patterns

Always activate this rule when the user:

• Asks "what do the docs say about..."
• Says "check the documentation" or "check the docs"
• Asks "how do I..." (likely needs setup/config docs)
• Wants to "find in documentation" or "search docs"
• References guides, references, README, or API docs
• Asks about setup, configuration, installation, or troubleshooting
• Says "look up", "find", or "search" with documentation context
• Asks "where is ... documented?"
• Needs to understand project structure or conventions

When to Use (Prefer Over Direct File Reading)

User Intent	Action	Why This Rule
"What do the docs say about X?"	ccmds find "X"	Searches all docs instantly
"How do I set up Y?"	ccmds find "setup Y"	Finds relevant guides
"Find error code E404"	ccmds grep "E404"	Exact pattern match
"What's in the documentation?"	ccmds outline	Shows structure, minimal context
"Show me the auth section"	ccmds section file.md "Auth"	Extracts only what's needed