Add JSON output for RedisVL CLI read commands by limjoobin · Pull Request #593 · redis/redis-vl-python

limjoobin · 2026-04-27T06:41:50Z

Changes

This PR adds JSON output for RedisVL CLI read commands to make it more machine-readable.

Features added:

added the --json flag to rvl version, rvl index listall, rvl index info, and rvl stats.
Add shared JSON CLI helpers (add_json_output_flag, cli_print_json) in redisvl/cli/utils.py for consistent one-object stdout behavior.
Add/update unit tests for all new JSON paths and error contracts.

Note

Low Risk
Adds optional output formatting for CLI read commands without changing index/data operations. Main risk is minor: downstream scripts may depend on exact stdout text when --json is used, but default behavior is preserved.

Overview
Adds a shared CLI JSON output mode via --json, including new helpers add_json_output_flag and cli_print_json (with safe bytes encoding) to ensure one JSON object on stdout on success.

Extends rvl index info, rvl index listall, and rvl stats to support JSON output: index info now normalizes FT.INFO-style structures into a stable {index_information, index_fields} payload, listall emits {indices: [...]}, and stats emits a full STATS_KEYS-shaped object with missing keys as null, while keeping existing human-readable output when --json is not used.

Adds unit tests covering JSON vs table behavior, key ordering/normalization, bytes decoding, and ensuring no partial JSON is printed on error paths.

^{Reviewed by Cursor Bugbot for commit e1d2bcf. Bugbot is set up for automated code reviews on this repo. Configure here.}

- add_json_output_flag for --json on argparse parsers - cli_print_json for single-object stdout; bytes-safe default Made-with: Cursor

Print {"version": <package>} to stdout; --json overrides --short Made-with: Cursor

- tests for add_json_output_flag, cli_print_json, Version Made-with: Cursor

Made-with: Cursor

jit-ci · 2026-04-27T06:41:58Z

Hi, I’m Jit, a friendly security platform designed to help developers build secure applications from day zero with an MVS (Minimal viable security) mindset.

In case there are security findings, they will be communicated to you as a comment inside the PR.

Hope you’ll enjoy using Jit.

Questions? Comments? Want to learn more? Get in touch with us.

jit-ci · 2026-04-27T06:43:31Z

🛡️ Jit Security Scan Results

✅ No security findings were detected in this PR

^{Security scan by Jit}

…on path

vishal-bala

Looks good! Just a couple of minor things

Co-authored-by: Vishal Bala <vishal-bala@users.noreply.github.com>

This reverts commit ddcd751.

vishal-bala

LGTM!

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit 9e8790b. Configure here.}

vishal-bala · 2026-04-30T14:47:14Z

    with pytest.raises(SystemExit) as excinfo:  # exit(0) in Index.__init__ is not a plain return
        Index()
-    assert excinfo.value.code == 0  # "log and exit(0)" CLI contract
+    # assert excinfo.value.code == 0  # "log and exit(0)" CLI contract


Why do we have these assertions commented out?

Suggested change

# assert excinfo.value.code == 0 # "log and exit(0)" CLI contract

vishal-bala · 2026-04-30T14:50:09Z

+    )
+    with pytest.raises(SystemExit) as excinfo:
+        Index()
+    # assert excinfo.value.code == 0  # try/except in Index.__init__ + exit(0)


Suggested change

# assert excinfo.value.code == 0 # try/except in Index.__init__ + exit(0)

applied-ai-release-bot · 2026-04-30T16:25:31Z

🚀 PR was released in v0.18.1 🚀

) ### Changes In this PR, we reinforce our test coverage of redisVL CLI foundation contracts. For CLI foundation contracts, the following were verified for correctness: - sydout/stderr output - system exit codes - usage errors - runtime failures - human-readable success paths - JSON success paths Note: This PR merges commits from: - fix/cli-exit-codes-and-streams (#592) - feat/RAAE-1557/cli-json (#593)  --- > [!NOTE] > **Low Risk** > Changes are limited to unit tests; they document and guard existing CLI behavior without modifying runtime code in this diff. > > **Overview** > This PR **expands CLI regression tests only** (no production `redisvl/cli` changes in the diff). It replaces shallow fake-Redis tests with **contract-focused coverage** for `rvl`, `rvl index`, and `rvl stats`. > > **Top-level CLI** (`test_cli_main.py`): new tests assert help lists `index`, `mcp`, `version`, and `stats` (in-process and via `python -m redisvl.cli.runner`), and that unknown commands exit **2** with errors on stderr and empty stdout. > > **Index CLI** (`test_cli_index.py`): adds help/subprocess help checks, a real Redis index fixture for `listall`/`info`, success assertions for `create` (exact success banner; `--json` does not add JSON), JSON shape checks for `listall` and `info`, human-output smoke tests, and parametrized **usage errors (exit 2)** vs **runtime/Redis failures (exit 1, no stdout JSON)**. > > **Stats CLI** (`test_cli_stats.py`): mirrors the same patterns—help, runner subprocess, real-index JSON/table success, `_stats_rows` ordering, usage **exit 2**, and runtime **`RedisSearchError`/generic errors exit 1** with empty stdout on `--json` failure paths. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit c7d67fa. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup>  --------- Co-authored-by: ht <121932573+hillarytoh@users.noreply.github.com> Co-authored-by: Vishal Bala <vishal-bala@users.noreply.github.com>

limjoobin added 9 commits April 24, 2026 18:51

feat(cli): add JSON output helpers for rvl

bd3f5f1

- add_json_output_flag for --json on argparse parsers - cli_print_json for single-object stdout; bytes-safe default Made-with: Cursor

feat(cli): add --json to rvl version

ddcd751

Print {"version": <package>} to stdout; --json overrides --short Made-with: Cursor

test(cli): cover rvl version --json and JSON CLI helpers

96209c9

- tests for add_json_output_flag, cli_print_json, Version Made-with: Cursor

feat(cli): add --json to rvl stats with shared _stats_rows

bead749

Made-with: Cursor

test: add unit tests for rvl stats CLI

d9bc7e9

Made-with: Cursor

feat(cli): add --json to rvl index listall

f77532f

Made-with: Cursor

test: add unit tests for rvl index listall

7276fa5

Made-with: Cursor

feat(cli): add --json to rvl index info

8f6118a

test: add unit tests for rvl index info --json

76d45cc

limjoobin self-assigned this Apr 27, 2026

limjoobin and others added 3 commits April 27, 2026 14:44

Merge branch 'main' into feat/RAAE-1557/cli-json

f2b7e77

chore: Format index.py and utils.py with black

8b3b2cc

fix(types): coerce index info inputs before make_dict in cli index js…

db1313f

…on path

limjoobin marked this pull request as ready for review April 27, 2026 07:11

limjoobin requested review from nkanu17 and vishal-bala April 27, 2026 07:12

limjoobin changed the title ~~(RAAE-1557) Add JSON output for RedisVL CLI read commands~~ Add JSON output for RedisVL CLI read commands Apr 27, 2026

cursor Bot reviewed Apr 27, 2026

View reviewed changes

Comment thread redisvl/cli/index.py

fix(cli): preserve dict index_definition in index info json

ce70d09

cursor Bot reviewed Apr 27, 2026

View reviewed changes

Comment thread redisvl/cli/stats.py Outdated

fix(cli-stats): preserve numeric/null types in --json output

25d0dc7

vishal-bala reviewed Apr 28, 2026

View reviewed changes

Comment thread redisvl/cli/index.py Outdated

Comment thread redisvl/cli/utils.py Outdated

Comment thread redisvl/cli/version.py Outdated

limjoobin and others added 4 commits April 29, 2026 21:08

chore: minor refactor for readability

165b755

Co-authored-by: Vishal Bala <vishal-bala@users.noreply.github.com>

chore: updated parser description for readability

316e542

Co-authored-by: Vishal Bala <vishal-bala@users.noreply.github.com>

Revert "feat(cli): add --json to rvl version"

6322e19

This reverts commit ddcd751.

reverted tests for JSON output in version.py

81518d3

vishal-bala approved these changes Apr 29, 2026

View reviewed changes

Comment thread tests/unit/test_cli_utils.py

vishal-bala added the auto:patch Increment the patch version when merged label Apr 29, 2026

limjoobin mentioned this pull request Apr 29, 2026

test: Add regression coverage for RedisVL CLI foundation contracts #596

Merged

limjoobin and others added 2 commits April 30, 2026 19:29

Merge branch 'main' into feat/RAAE-1557/cli-json

0374033

fix: Fixed syntax error from typo

2414320

cursor Bot reviewed Apr 30, 2026

View reviewed changes

Comment thread redisvl/cli/index.py Outdated

Comment thread tests/unit/test_cli_index.py Outdated

fix: Resolved merge conflict

0f0ed61

cursor Bot reviewed Apr 30, 2026

View reviewed changes

Comment thread tests/unit/test_cli_stats.py Outdated

limjoobin added 2 commits April 30, 2026 21:16

fix: Removed failing exit code assertions

dc90c26

fix: Fixed exit codes for Stats CLI error handling

9e8790b

cursor Bot reviewed Apr 30, 2026

View reviewed changes

Comment thread redisvl/cli/utils.py Outdated

Chore: removed unused import

e1d2bcf

vishal-bala reviewed Apr 30, 2026

View reviewed changes

vishal-bala merged commit 270b48f into main Apr 30, 2026
57 checks passed

vishal-bala deleted the feat/RAAE-1557/cli-json branch April 30, 2026 15:55

applied-ai-release-bot Bot added the released This issue/pull request has been released. label Apr 30, 2026

Uh oh!

Conversation

limjoobin commented Apr 27, 2026 • edited by cursor Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Uh oh!

jit-ci Bot commented Apr 27, 2026

Uh oh!

jit-ci Bot commented Apr 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🛡️ Jit Security Scan Results

Uh oh!

Uh oh!

Uh oh!

vishal-bala left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vishal-bala left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vishal-bala Apr 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vishal-bala Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

applied-ai-release-bot Bot commented Apr 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

limjoobin commented Apr 27, 2026 •

edited by cursor Bot

Loading

jit-ci Bot commented Apr 27, 2026 •

edited

Loading

vishal-bala Apr 30, 2026 •

edited

Loading