This repository ships a reusable skill that gives AI coding agents the package’s installation, configuration, indexing, query, testing, and troubleshooting workflow.
Canonical skill
The single source of truth is:
.agents/skills/scout-redis-search/SKILL.mdThe skill also includes provider-specific guidance under
.agents/skills/scout-redis-search/references/provider-adapters.md. Keep the
package workflow in SKILL.md; provider files should only adapt discovery and
activation.
Automatic discovery
The repository contains lightweight adapters for common coding agents:
| Agent | Discovery file or directory |
|---|---|
| OpenAI Codex / Gemini CLI | .agents/skills/scout-redis-search/ |
| Claude Code | CLAUDE.md imports AGENTS.md |
| Cursor | .cursor/rules/scout-redis-search.mdc |
| GitHub Copilot | .github/copilot-instructions.md |
| Windsurf / Cascade | .devin/rules/ or .windsurf/rules/ |
When an agent does not support SKILL.md directly, its adapter tells the agent
to read the canonical skill instead of maintaining a second package guide.
Explicit use
For a Codex task, mention the skill directly:
$scout-redis-search Install this package in the current Laravel application.For other agents, ask them to read
.agents/skills/scout-redis-search/SKILL.md before changing Composer, Scout,
Redis, schemas, searchable models, or tests.
Scope and safety
The skill does not run Composer updates automatically. Update the package in a consuming Laravel application manually, then create or recreate RediSearch indexes and import existing records when the schema requires it.
It also preserves two important constraints:
- Redis must provide RediSearch for
FT.CREATEandFT.SEARCH; - untrusted request input must never be passed through
raw_query.