mirror of
https://github.com/redis/agent-skills.git
synced 2026-09-19 01:25:14 +08:00
Rename skill to redis-development
This commit is contained in:
@@ -27,7 +27,7 @@ skills/
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
- **Skill directory**: `kebab-case` (e.g., `redis-best-practices`, `redis-monitoring`)
|
||||
- **Skill directory**: `kebab-case` (e.g., `redis-development`, `redis-monitoring`)
|
||||
- **SKILL.md, AGENTS.md**: Always uppercase
|
||||
- **Rule files**: `{prefix}-{description}.md` where prefix maps to section
|
||||
- **Scripts**: `kebab-case.sh`
|
||||
@@ -125,15 +125,14 @@ Reference: [Link](URL)
|
||||
- Create `rules/_sections.md` defining categories
|
||||
- Create `rules/_template.md` for contributors
|
||||
- Add rules as `rules/{prefix}-{name}.md`
|
||||
- Add skill config to `packages/redis-best-practices-build/src/config.ts`
|
||||
- Add skill config to `packages/redis-development-build/src/config.ts`
|
||||
- Run `npm run build` to generate AGENTS.md
|
||||
|
||||
### Build System
|
||||
|
||||
The build tooling in `packages/redis-best-practices-build/` compiles individual rule files into AGENTS.md:
|
||||
The build tooling in `packages/redis-development-build/` compiles individual rule files into AGENTS.md:
|
||||
|
||||
```bash
|
||||
cd packages/redis-best-practices-build
|
||||
npm install
|
||||
npm run validate # Check rule structure
|
||||
npm run build # Generate AGENTS.md
|
||||
|
||||
+1
-1
@@ -10,7 +10,7 @@ This installs dependencies and sets up Git hooks (via Husky) that validate and b
|
||||
|
||||
## Adding Rules
|
||||
|
||||
Rules live in `skills/<skill-name>/rules/`. See `skills/redis-best-practices/` for an example.
|
||||
Rules live in `skills/<skill-name>/rules/`. See `skills/redis-development/` for an example.
|
||||
|
||||
To add a new rule:
|
||||
|
||||
|
||||
@@ -6,30 +6,9 @@ Skills follow the [Agent Skills](https://agentskills.io/) format.
|
||||
|
||||
## Available Skills
|
||||
|
||||
### redis-best-practices
|
||||
|
||||
Redis performance optimization and best practices. Contains 29 rules across 11 categories, prioritized by impact.
|
||||
|
||||
**Use when:**
|
||||
- Writing code that interacts with Redis
|
||||
- Choosing data structures or designing key schemas
|
||||
- Using Redis Query Engine (FT.CREATE, FT.SEARCH, FT.AGGREGATE)
|
||||
- Building vector search or RAG applications with RedisVL
|
||||
- Implementing semantic caching with LangCache
|
||||
- Optimizing Redis performance and memory usage
|
||||
|
||||
**Categories covered:**
|
||||
- Data Structures & Keys (High)
|
||||
- Memory & Expiration (High)
|
||||
- Connection & Performance (High)
|
||||
- JSON Documents (Medium)
|
||||
- Redis Query Engine (High)
|
||||
- Vector Search & RedisVL (High)
|
||||
- Semantic Caching (Medium)
|
||||
- Streams & Pub/Sub (Medium)
|
||||
- Clustering & Replication (Medium)
|
||||
- Security (High)
|
||||
- Observability (Medium)
|
||||
| Skill | Description |
|
||||
|-------|-------------|
|
||||
| [redis-development](skills/redis-development/) | Redis development best practices — data structures, query engine, vector search, caching, and performance optimization. |
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -65,7 +44,6 @@ Each skill contains:
|
||||
For rule-based skills, build the compiled AGENTS.md:
|
||||
|
||||
```bash
|
||||
cd packages/redis-best-practices-build
|
||||
npm install
|
||||
npm run validate # Validate rule files
|
||||
npm run build # Build AGENTS.md
|
||||
|
||||
Generated
+3
-3
@@ -550,8 +550,8 @@
|
||||
"url": "https://github.com/sponsors/typicode"
|
||||
}
|
||||
},
|
||||
"node_modules/redis-best-practices-build": {
|
||||
"resolved": "packages/redis-best-practices-build",
|
||||
"node_modules/redis-development-build": {
|
||||
"resolved": "packages/redis-development-build",
|
||||
"link": true
|
||||
},
|
||||
"node_modules/resolve-pkg-maps": {
|
||||
@@ -605,7 +605,7 @@
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"packages/redis-best-practices-build": {
|
||||
"packages/redis-development-build": {
|
||||
"version": "1.0.0",
|
||||
"license": "MIT",
|
||||
"devDependencies": {
|
||||
|
||||
+2
-2
@@ -5,8 +5,8 @@
|
||||
"packages/*"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "npm run build --workspace=redis-best-practices-build",
|
||||
"validate": "npm run validate --workspace=redis-best-practices-build",
|
||||
"build": "npm run build --workspace=redis-development-build",
|
||||
"validate": "npm run validate --workspace=redis-development-build",
|
||||
"prepare": "husky"
|
||||
},
|
||||
"devDependencies": {
|
||||
|
||||
+2
-2
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "redis-best-practices-build",
|
||||
"name": "redis-development-build",
|
||||
"version": "1.0.0",
|
||||
"description": "Build tooling for Redis Best Practices skill",
|
||||
"description": "Build tooling for Redis Development skill",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"build": "npx tsx src/build.ts --all",
|
||||
+8
-8
@@ -24,14 +24,14 @@ export interface SkillConfig {
|
||||
}
|
||||
|
||||
export const SKILLS: Record<string, SkillConfig> = {
|
||||
'redis-best-practices': {
|
||||
name: 'redis-best-practices',
|
||||
title: 'Redis Best Practices',
|
||||
'redis-development': {
|
||||
name: 'redis-development',
|
||||
title: 'Redis Development',
|
||||
description: 'Redis applications',
|
||||
skillDir: join(SKILLS_DIR, 'redis-best-practices'),
|
||||
rulesDir: join(SKILLS_DIR, 'redis-best-practices/rules'),
|
||||
metadataFile: join(SKILLS_DIR, 'redis-best-practices/metadata.json'),
|
||||
outputFile: join(SKILLS_DIR, 'redis-best-practices/AGENTS.md'),
|
||||
skillDir: join(SKILLS_DIR, 'redis-development'),
|
||||
rulesDir: join(SKILLS_DIR, 'redis-development/rules'),
|
||||
metadataFile: join(SKILLS_DIR, 'redis-development/metadata.json'),
|
||||
outputFile: join(SKILLS_DIR, 'redis-development/AGENTS.md'),
|
||||
sectionMap: {
|
||||
data: 1,
|
||||
ram: 2,
|
||||
@@ -49,7 +49,7 @@ export const SKILLS: Record<string, SkillConfig> = {
|
||||
}
|
||||
|
||||
// Default skill
|
||||
export const DEFAULT_SKILL = 'redis-best-practices'
|
||||
export const DEFAULT_SKILL = 'redis-development'
|
||||
|
||||
// Legacy exports for backwards compatibility
|
||||
export const SKILL_DIR = SKILLS[DEFAULT_SKILL].skillDir
|
||||
@@ -1,4 +1,4 @@
|
||||
# Redis Best Practices
|
||||
# Redis Development
|
||||
|
||||
**Version 1.0.0**
|
||||
Redis, Inc.
|
||||
@@ -1,6 +1,6 @@
|
||||
# Redis Best Practices
|
||||
# Redis Development
|
||||
|
||||
A structured repository for creating and maintaining Redis Best Practices optimized for agents and LLMs.
|
||||
A structured repository for creating and maintaining Redis development guidelines optimized for agents and LLMs.
|
||||
|
||||
|
||||
## Structure
|
||||
@@ -18,12 +18,7 @@ A structured repository for creating and maintaining Redis Best Practices optimi
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. Navigate to the build package:
|
||||
```bash
|
||||
cd ../../packages/redis-best-practices-build
|
||||
```
|
||||
|
||||
2. Install dependencies:
|
||||
1. Install dependencies from the repo root:
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
@@ -109,7 +104,7 @@ Reference: [Link](https://example.com/)
|
||||
|
||||
## Scripts
|
||||
|
||||
(Run these from `../../packages/redis-best-practices-build`)
|
||||
(Run these from the repo root)
|
||||
|
||||
- `npm run build` - Compile rules into AGENTS.md
|
||||
- `npm run validate` - Validate all rule files
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
name: redis-best-practices
|
||||
name: redis-development
|
||||
description: Redis performance optimization and best practices. Use this skill when working with Redis data structures, Redis Query Engine (RQE), vector search with RedisVL, semantic caching with LangCache, or optimizing Redis performance.
|
||||
license: MIT
|
||||
metadata:
|
||||
Reference in New Issue
Block a user