关于 redis-development
redis-development 是面向 Redis 开发者的性能与实现指南,涵盖数据建模、查询、缓存和实时系统。规则涉及 11 个领域,包括 Redis Query Engine、向量搜索、安全和可观测性。
主要功能
- 01涵盖 11 类的 29 条规则
- 02数据结构与内存指南
- 03Redis Query Engine 实践
- 04向量搜索与 RAG 指南
- 05安全与可观测性实践
适用场景
- 01优化 Redis 内存和性能
- 02构建向量搜索或 RAG 应用
- 03实现语义缓存
- 04审查 Redis 安全与监控
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ redis/ agent-skills --skill redis-development安装后在 Claude Code 中输入/redis-development确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
README.mdAGENTS.mdmetadata.json.cursor-plugin/plugin.jsonevals/README.mdevals/data-structures-key-naming/evals.jsonmodel-matrix.jsonevals/data-structures-key-naming/baselines/baseline.jsonaggregate-benchmark.mdREADME.mdaggregate-benchmark.jsonmodel-matrix.jsonrules/_contributing.mdcluster-hash-tags.md_sections.md_template.mdconn-timeouts.mdconn-client-cache.mdconn-pooling.mddata-choose-structure.mdcluster-read-replicas.mdconn-blocking.mdconn-pipelining.mddata-hash-field-expiry.mddata-incr.mdobserve-commands.mdram-limits.mdram-ttl.mdjson-partial-updates.mddata-key-naming.md详细介绍
Redis 最佳实践
Redis 性能优化综合指南,涵盖 Redis Query Engine、向量搜索和语义缓存。包含 11 个类别中的 29 条规则,并按影响程度排序,以指导自动化优化和代码生成。
适用场景
以下情况可参考这些指南:
- 设计 Redis 数据模型和键结构
- 实现缓存、会话或实时功能
- 使用 Redis Query Engine(FT.CREATE、FT.SEARCH、FT.AGGREGATE)
- 使用 RedisVL 构建向量搜索或 RAG 应用
- 使用 LangCache 实现语义缓存
- 优化 Redis 性能和内存使用
按优先级划分的规则类别
| 优先级 | 类别 | 影响 | 前缀 |
|---|---|---|---|
| 1 | 数据结构与键 | 高 | data- |
| 2 | 内存与过期 | 高 | ram- |
| 3 | 连接与性能 | 高 | conn- |
| 4 | JSON 文档 | 中 | json- |
| 5 | Redis Query Engine | 高 | rqe- |
| 6 | 向量搜索与 RedisVL | 高 | vector- |
| 7 | 语义缓存 | 中 | semantic-cache- |
| 8 | 流与发布/订阅 | 中 | stream- |
| 9 | 集群与复制 | 中 | cluster- |
| 10 | 安全 | 高 | security- |
| 11 | 可观测性 | 中 | observe- |
快速参考
1. 数据结构与键(高)
data-choose-structure- 选择合适的数据结构data-key-naming- 使用一致的键命名约定
2. 内存与过期(高)
ram-limits- 配置内存限制和淘汰策略ram-ttl- 为缓存键设置 TTL
3. 连接与性能(高)
conn-blocking- 避免在生产环境中使用慢速命令conn-pipelining- 使用流水线执行批量操作conn-pooling- 使用连接池或多路复用conn-timeouts- 配置连接超时
4. JSON 文档(中)
json-partial-updates- 使用 JSON 路径进行部分更新json-vs-hash- 根据情况选择 JSON 或 Hash
5. Redis Query Engine(高)
rqe-dialect- 对查询语法使用 DIALECT 2rqe-field-types- 选择正确的字段类型rqe-index-creation- 仅为要查询的字段创建索引rqe-index-management- 管理索引以实现零停机更新rqe-query-optimization- 编写高效查询
6. 向量搜索与 RedisVL(高)
vector-algorithm-choice- 根据需求选择 HNSW 或 FLATvector-hybrid-search- 使用混合搜索以获得更好的结果vector-index-creation- 正确配置向量索引vector-rag-pattern- 正确实现 RAG 模式
7. 语义缓存(中)
semantic-cache-best-practices- 正确配置语义缓存semantic-cache-langcache-usage- 使用 LangCache 缓存大模型响应
8. 流与发布/订阅(中)
stream-choosing-pattern- 根据情况选择 Streams 或 Pub/Sub
9. 集群与复制(中)
cluster-hash-tags- 使用哈希标签执行多键操作cluster-read-replicas- 为读密集型工作负载使用只读副本
10. 安全(高)
security-acls- 使用 ACL 实现细粒度访问控制security-auth- 在生产环境中始终启用身份验证security-network- 保护网络访问
11. 可观测性(中)
observe-commands- 使用可观测性命令进行调试observe-metrics- 监控 Redis 关键指标
使用方法
阅读各规则文件,了解详细说明和代码示例:
rules/rqe-index-creation.md
rules/vector-rag-pattern.md
每个规则文件都包含:
- 对规则重要性的简要说明
- 正确示例及其说明
- “错误”示例(针对会造成实际危害的反模式),或“何时使用/何时无需使用”指南(针对可选功能)
- 补充背景信息和参考资料
完整汇编文档
如需查看包含所有规则详细内容的完整指南,请参阅:AGENTS.md
评论
支持 Markdown