Skip to content

Audit RedisVL CLI surface area and propose expansion roadmap #498

@tylerhutcherson

Description

@tylerhutcherson

Summary

Audit RedisVL CLI command surface area and propose a prioritized roadmap for expanding CLI capabilities.

Level: Intermediate

Current State

  • CLI functionality exists primarily under redisvl/cli/ with commands such as index operations, stats, and version.
  • Core Python APIs provide a wider capability surface than CLI currently exposes.
  • There is no consolidated CLI parity matrix against core RedisVL functionality.

Proposed Change

  • Perform a research-driven CLI audit and publish recommendations:
    • inventory current CLI commands and flags
    • map command coverage against high-value Python API capabilities
    • identify gaps (query workflows, maintenance ops, schema utilities, diagnostics, export/import)
    • define a phased roadmap (quick wins vs medium effort)
    • propose UX conventions for argument patterns and output format consistency
  • Produce one written deliverable in-repo (design doc or ADR-style markdown).

Definition of Done

  • A documented CLI capability matrix exists.
  • Recommendations include prioritized candidates with rough implementation scope.
  • At least 5 concrete proposed CLI enhancements are described with examples.
  • Includes suggested follow-up issue breakdown for implementation.

Out of Scope

  • Implementing all proposed CLI commands in this task.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions