redis-vl-python CLAUDE.md

A set of project instructions for working on RedisVL, a Python project that connects Redis with vector search, including its commands, development workflow, and Redis setup.

In plain words
What is it for?
Use it when installing dependencies, formatting code, checking types, running tests, starting or stopping Redis, building documentation, or following the project’s async, sync, and schema-based patterns.
Why use it?
It gives a coding agent the project-specific conventions and commands needed to make changes consistently and check them before committing.

Instructions file

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/redis/redis-vl-python/claude-md
Clone the repo
git clone --depth 1 https://github.com/redis/redis-vl-python
Per session 1,033 This file is loaded in full into every session.
When invoked 1,033 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.01033 $0.01033
Opus 5 $0.00517 $0.00517
Sonnet 5 $0.00207 $0.00207
Haiku 4.5 $0.00103 $0.00103

Measured 2d ago against content hash adab844c087c, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

redis-vl-python CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 128 lines

How it starts

The opening of the file, as written. The whole thing — 128 lines — stays where its author put it; the contents beside it link to each section on GitHub.

CLAUDE.md - RedisVL Project Context

Frequently Used Commands

# Development workflow
make install          # Install dependencies
make format           # Format code (black + isort)
make check-types      # Run mypy type checking
make lint             # Run all linting (format + types)
make test             # Run tests (no external APIs)
make test-all         # Run all tests (includes API tests)
make check            # Full check (lint + test)

# Redis setup
make redis-start      # Start Redis container
make redis-stop       # Stop Redis container

# Documentation
make docs-build       # Build documentation
make docs-serve       # Serve docs locally

Pre-commit hooks are also configured, which you should run before you commit:

pre-commit run --all-files

Important Architectural Patterns

Async/Sync Dual Interfaces

  • Most core classes have both sync and async versions (e.g., SearchIndex / AsyncSearchIndex)
  • Follow existing patterns when adding new functionality

Schema-Driven Design

# Index schemas define structure
schema = IndexSchema.from_yaml("schema.yaml")
index = SearchIndex(schema, redis_url="redis://localhost:6379")

Critical Rules

Do Not Modify

  • CRITICAL: Do not change this line unless explicitly asked:
    token.strip().strip(",").replace(""", "").replace(""", "").lower()
    

Protected Directories

CRITICAL: NEVER delete the local_docs/ directory or any files within it.

Git Operations

CRITICAL: NEVER use git push or attempt to push to remote repositories. The user will handle all git push operations.

Code Quality

IMPORTANT: Always run make format before committing code to ensure proper formatting and linting compliance.

README.md Maintenance

IMPORTANT: DO NOT modify README.md unless explicitly requested.

If you need to document something, use these alternatives:

  • Development info → CONTRIBUTING.md
  • API details → docs/ directory
  • Examples → docs/examples/
  • Project memory (explicit preferences, directives, etc.) → CLAUDE.md

Read the full file on GitHub · 128 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 128 lines · 1,033 tokens per session scan A adab844c087c

Subscribe to this mod's changes

redis-vl-python CLAUDE.md is an instructions file published in the GitHub repository redis/redis-vl-python (424 stars, last pushed 5d ago), licensed MIT. It adds 1,033 tokens to every session, about $0.0052 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories