feat(cli): hide $HOME when printing paths as output

Author: Davidyz

src/vectorcode/cli_utils.py

@@ -508,6 +508,12 @@ async def expand_globs(
     return list(result)
 
 
+def cleanup_path(path: str):
+    if os.path.isabs(path) and os.environ.get("HOME") is not None:
+        return path.replace(os.environ["HOME"], "~")
+    return path
+
+
 def config_logging(
     name: str = "vectorcode", stdio: bool = True, log_file: bool = False
 ):  # pragma: nocover

src/vectorcode/mcp_main.py

@@ -23,6 +23,7 @@
 
 from vectorcode.cli_utils import (
     Config,
+    cleanup_path,
     config_logging,
     find_project_config_dir,
     get_project_config,
@@ -76,7 +77,7 @@ async def list_collections() -> list[str]:
         client = await get_client(await load_config_file())
     async for col in get_collections(client):
         if col.metadata is not None:
-            names.append(str(col.metadata.get("path")))
+            names.append(cleanup_path(str(col.metadata.get("path"))))
     logger.info("Retrieved the following collections: %s", names)
     return names
 
@@ -92,6 +93,7 @@ async def query_tool(
     logger.info(
         f"query tool called with the following args: {n_query=}, {query_messages=}, {project_root=}"
     )
+    project_root = os.path.expanduser(project_root)
     if not os.path.isdir(project_root):
         logger.error("Invalid project root: %s", project_root)
         raise McpError(

src/vectorcode/subcommands/ls.py

@@ -7,7 +7,7 @@
 from chromadb.api import AsyncClientAPI
 from chromadb.api.types import IncludeEnum
 
-from vectorcode.cli_utils import Config
+from vectorcode.cli_utils import Config, cleanup_path
 from vectorcode.common import get_client, get_collections
 
 logger = logging.getLogger(name=__name__)
@@ -23,7 +23,7 @@ async def get_collection_list(client: AsyncClientAPI) -> list[dict]:
         )
         result.append(
             {
-                "project-root": meta["path"],
+                "project-root": cleanup_path(meta["path"]),
                 "user": meta.get("username"),
                 "hostname": socket.gethostname(),
                 "collection_name": collection.name,

src/vectorcode/subcommands/query/__init__.py

@@ -8,7 +8,13 @@
 from chromadb.errors import InvalidCollectionException, InvalidDimensionException
 
 from vectorcode.chunking import StringChunker
-from vectorcode.cli_utils import Config, QueryInclude, expand_globs, expand_path
+from vectorcode.cli_utils import (
+    Config,
+    QueryInclude,
+    cleanup_path,
+    expand_globs,
+    expand_path,
+)
 from vectorcode.common import (
     get_client,
     get_collection,
@@ -130,6 +136,9 @@ async def build_query_results(
             logger.warning(
                 f"{identifier} is no longer a valid file! Please re-run vectorcode vectorise to refresh the database.",
             )
+    for result in structured_result:
+        if result.get("path") is not None:
+            result["path"] = cleanup_path(result["path"])
     return structured_result
 
 

tests/test_cli_utils.py

@@ -10,6 +10,7 @@
     CliAction,
     Config,
     QueryInclude,
+    cleanup_path,
     expand_envs_in_dict,
     expand_globs,
     expand_path,
@@ -489,3 +490,13 @@ async def test_hnsw_config_merge():
     assert merged_config.port == 8001
     assert merged_config.hnsw["space"] == "ip"
     assert merged_config.hnsw["ef_construction"] == 200
+
+
+def test_cleanup_path():
+    home = os.environ.get("HOME")
+    if home is None:
+        return
+    assert cleanup_path(os.path.join(home, "test_path")) == os.path.join(
+        "~", "test_path"
+    )
+    assert cleanup_path("/etc/dir") == "/etc/dir"