docs: add CLI reference page and remove dead format flag (#499)

Add dedicated CLI reference documentation following Diataxis framework:

- Create docs/api/cli.rst with complete command reference including
  syntax, options, connection configuration, and help documentation
- Add CLI to API docs toctree
- Add CLI how-to card linking to existing tutorial
- Cross-link tutorial to reference page

Remove dead code:
- Delete unused -f/--format flag from rvl index and rvl stats commands
- Flag accepted parameter but never used it in display functions

Author: nkanu17

docs/api/index.md

@@ -23,5 +23,6 @@ reranker
 cache
 message_history
 router
+cli
 ```
 

docs/user_guide/cli.ipynb

@@ -12,7 +12,9 @@
     "\n",
     "Before running this notebook, be sure to\n",
     "1. Have installed ``redisvl`` and have that environment active for this notebook.\n",
-    "2. Have a running Redis instance with Redis Search enabled"
+    "2. Have a running Redis instance with Redis Search enabled\n",
+    "\n",
+    "For complete command syntax and options, see the [CLI Reference](../api/cli.rst)."
    ]
   },
   {

docs/user_guide/how_to_guides/index.md

@@ -36,6 +36,11 @@ How-to guides are **task-oriented** recipes that help you accomplish specific go
 - [Choose a Storage Type](../05_hash_vs_json.ipynb) -- Hash vs JSON formats and nested data
 :::
 
+:::{grid-item-card} 💻 CLI Operations
+
+- [Manage Indices with the CLI](../cli.ipynb) -- create, inspect, and delete indices from your terminal
+:::
+
 ::::
 
 ## Quick Reference
@@ -53,6 +58,7 @@ How-to guides are **task-oriented** recipes that help you accomplish specific go
 | Improve search accuracy | [Rerank Search Results](../06_rerankers.ipynb) |
 | Optimize index performance | [Optimize Indexes with SVS-VAMANA](../09_svs_vamana.ipynb) |
 | Decide on storage format | [Choose a Storage Type](../05_hash_vs_json.ipynb) |
+| Manage indices from terminal | [Manage Indices with the CLI](../cli.ipynb) |
 
 ```{toctree}
 :hidden:

redisvl/cli/index.py

@@ -30,13 +30,6 @@ def __init__(self):
         parser = argparse.ArgumentParser(usage=self.usage)
 
         parser.add_argument("command", help="Subcommand to run")
-        parser.add_argument(
-            "-f",
-            "--format",
-            help="Output format for info command",
-            type=str,
-            default="rounded_outline",
-        )
         parser = add_index_parsing_options(parser)
 
         args = parser.parse_args(sys.argv[2:])

redisvl/cli/stats.py

@@ -42,10 +42,6 @@ class Stats:
 
     def __init__(self):
         parser = argparse.ArgumentParser(usage=self.usage)
-
-        parser.add_argument(
-            "-f", "--format", help="Output format", type=str, default="rounded_outline"
-        )
         parser = add_index_parsing_options(parser)
         args = parser.parse_args(sys.argv[2:])
         try:
@@ -61,7 +57,7 @@ def stats(self, args: Namespace):
             rvl stats -i <index_name> | -s <schema_path>
         """
         index = self._connect_to_index(args)
-        _display_stats(index.info(), output_format=args.format)
+        _display_stats(index.info())
 
     def _connect_to_index(self, args: Namespace) -> SearchIndex:
         # connect to redis
@@ -85,7 +81,7 @@ def _connect_to_index(self, args: Namespace) -> SearchIndex:
         return index
 
 
-def _display_stats(index_info, output_format="rounded_outline"):
+def _display_stats(index_info):
     # Extracting the statistics
     stats_data = [(key, str(index_info.get(key))) for key in STATS_KEYS]