ravmem-cli 0.1.0__tar.gz → 1.0.0__tar.gz

{ravmem_cli-0.1.0/ravmem_cli.egg-info → ravmem_cli-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ravmem-cli
-Version: 0.1.0
+Version: 1.0.0
 Summary: RavMem CLI — lightweight client for the RavMem code knowledge graph server
 Author-email: RavMem <harpreet.singh@ravmem.com>
 License-Expression: MIT
@@ -18,9 +18,14 @@ Requires-Dist: typer[all]>=0.12.0
 Requires-Dist: httpx>=0.27.0
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: pydantic>=2.0
+Requires-Dist: uvicorn>=0.27.0
+Requires-Dist: rich>=13.0
+Provides-Extra: serve
+Requires-Dist: ravmem-server>=0.2.2; extra == "serve"
 Provides-Extra: dev
 Requires-Dist: pytest>=8.0.0; extra == "dev"
 Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
+Requires-Dist: pytest-httpx>=0.30.0; extra == "dev"
 Dynamic: license-file
 
 # ravmem-cli

{ravmem_cli-0.1.0 → ravmem_cli-1.0.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ravmem-cli"
-version = "0.1.0"
+version = "1.0.0"
 description = "RavMem CLI — lightweight client for the RavMem code knowledge graph server"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -26,15 +26,21 @@ dependencies = [
     "httpx>=0.27.0",
     "pyyaml>=6.0",
     "pydantic>=2.0",
+    "uvicorn>=0.27.0",
+    "rich>=13.0",
 ]
 
 [project.urls]
 Homepage = "https://www.ravmem.com"
 
 [project.optional-dependencies]
+serve = [
+    "ravmem-server>=0.2.2",
+]
 dev = [
     "pytest>=8.0.0",
     "pytest-asyncio>=0.23.0",
+    "pytest-httpx>=0.30.0",
 ]
 
 [project.scripts]

ravmem_cli-1.0.0/ravmem/cli/_common.py

@@ -0,0 +1,41 @@
+"""Shared helpers for ravmem CLI commands."""
+
+from __future__ import annotations
+
+import subprocess
+from pathlib import Path
+from typing import Optional
+
+import typer
+
+
+def detect_branch(repo_path: Path, explicit: Optional[str]) -> str:
+    if explicit:
+        return explicit
+    try:
+        out = subprocess.run(
+            ["git", "-C", str(repo_path), "rev-parse", "--abbrev-ref", "HEAD"],
+            capture_output=True, text=True, check=True,
+        ).stdout.strip()
+        return out if out and out != "HEAD" else "main"
+    except Exception:
+        return "main"
+
+
+def get_client(remote: Optional[str]):
+    from ravmem.client.api import RavMemClient
+    from ravmem.client.config import load_config
+
+    url = remote
+    api_key = None
+    if not url:
+        cfg = load_config()
+        url = cfg.get("server_url")
+        api_key = cfg.get("api_key")
+    if not url:
+        typer.echo(
+            "No server configured. Run: ravmem remote config --url <URL>",
+            err=True,
+        )
+        raise typer.Exit(1)
+    return RavMemClient(base_url=url, api_key=api_key or None)

ravmem_cli-1.0.0/ravmem/cli/_errors.py

@@ -0,0 +1,102 @@
+"""Shared CLI error-handling utilities.
+
+All CLI modules import from here so every command surfaces the same
+clean, human-readable messages instead of raw Python tracebacks.
+"""
+from __future__ import annotations
+
+import typer
+
+
+def _extract_detail(exc) -> str:
+    """Pull the best human-readable string out of an httpx HTTP error body."""
+    try:
+        body = exc.response.json()
+        if isinstance(body, dict):
+            detail = body.get("detail") or body.get("message") or body.get("error")
+            if isinstance(detail, list):
+                # FastAPI validation error list - join the loc + msg pairs
+                parts = []
+                for item in detail:
+                    loc = " -> ".join(str(x) for x in item.get("loc", []))
+                    msg = item.get("msg", "")
+                    parts.append(f"{loc}: {msg}" if loc else msg)
+                return "; ".join(parts)
+            if detail:
+                return str(detail)
+        return exc.response.text or str(exc)
+    except Exception:
+        return exc.response.text or str(exc)
+
+
+def handle_error(exc: Exception, server_url: str = "") -> None:
+    """Print a clean, user-friendly error message to stderr.
+
+    Does NOT raise - callers are responsible for raising typer.Exit(1) after.
+    """
+    import httpx
+
+    if isinstance(exc, (httpx.ConnectError, httpx.ConnectTimeout)):
+        target = server_url
+        if not target:
+            try:
+                target = str(exc.request.url) if exc.request else ""
+            except Exception:
+                pass
+        target = target or "the server"
+        typer.echo(
+            f"Error: Cannot connect to {target}.\n"
+            "  Is the server running? Check: ravmem health",
+            err=True,
+        )
+    elif isinstance(exc, httpx.TimeoutException):
+        typer.echo(
+            "Error: Request timed out. The server may be overloaded or unreachable.",
+            err=True,
+        )
+    elif isinstance(exc, httpx.RemoteProtocolError):
+        typer.echo(
+            f"Error: Invalid response from server - {exc}",
+            err=True,
+        )
+    elif isinstance(exc, httpx.HTTPStatusError):
+        code = exc.response.status_code
+        detail = _extract_detail(exc)
+        if code == 400:
+            typer.echo(f"Error: Bad request - {detail}", err=True)
+        elif code == 401:
+            typer.echo(
+                "Error: Not authenticated.\n"
+                "  Set an API token with: ravmem remote config --api-key <TOKEN>\n"
+                "  Or log in with:        ravmem auth login",
+                err=True,
+            )
+        elif code == 403:
+            typer.echo(
+                "Error: Permission denied - your token does not have the required permission.\n"
+                "  Ask an admin to grant the necessary role.",
+                err=True,
+            )
+        elif code == 404:
+            typer.echo(f"Error: Not found - {detail}", err=True)
+        elif code == 409:
+            typer.echo(f"Error: Conflict - {detail}", err=True)
+        elif code == 422:
+            typer.echo(f"Error: Invalid request parameters - {detail}", err=True)
+        elif code == 429:
+            typer.echo(
+                "Error: Rate limit exceeded - too many requests. Wait a moment and retry.",
+                err=True,
+            )
+        elif code == 500:
+            typer.echo(f"Error: Server error - {detail}", err=True)
+        elif code == 503:
+            typer.echo(
+                f"Error: Server unavailable - {detail}\n"
+                "  ArcadeDB may be starting up. Check: ravmem health",
+                err=True,
+            )
+        else:
+            typer.echo(f"Error {code}: {detail}", err=True)
+    else:
+        typer.echo(f"Error: {exc}", err=True)

{ravmem_cli-0.1.0 → ravmem_cli-1.0.0}/ravmem/cli/analyze.py

@@ -8,6 +8,8 @@ from typing import Optional
 
 import typer
 
+from ravmem.cli._common import get_client as _get_client_shared
+from ravmem.client.api import handle_api_error
 from ravmem.config import DEFAULT_LANGS
 
 # Extensions whose content is never useful for the code-graph pipeline.
@@ -38,23 +40,7 @@ _CLI_MAX_FILE_BYTES = 5 * 1024 * 1024
 
 
 def _get_client(remote: str | None):
-    from ravmem.client.api import RavMemClient
-    from ravmem.client.config import load_config
-
-    url = remote
-    api_key = None
-    if not url:
-        cfg = load_config()
-        url = cfg.get("server_url")
-        api_key = cfg.get("api_key")
-    if not url:
-        typer.echo(
-            "Error: No server configured. "
-            "Run `ravmem remote config --url <URL>` or pass --remote <URL>.",
-            err=True,
-        )
-        raise typer.Exit(1)
-    return RavMemClient(base_url=url, api_key=api_key or None)
+    return _get_client_shared(remote)
 
 
 def _print_job_result(job: dict) -> None:
@@ -395,7 +381,35 @@ def analyze_cmd(
              "Use when you know the workspace is already up to date.",
     ),
 ) -> None:
-    """Index a repository — detects upload/clone/mount mode from the project registration."""
+    """Index a repository (auto-detects mode from the project registration).
+
+    \b
+    Register your project first with `ravmem remote add`, then run this command.
+
+    \b
+    Mode behaviour:
+      upload  — CLI reads committed files locally and pushes them to the server.
+                The project must be registered without --git-url and without --mount.
+                Only committed files are indexed; commit before running.
+      clone   — Server pulls from the git remote it cloned at registration.
+                No local files are uploaded. Use `ravmem remote clone` for first run.
+      mount   — Server reads directly from the mounted path. No upload needed.
+
+    \b
+    Quick-start examples:
+      # Upload mode (local repo → server)
+      ravmem remote add /my/repo --name myproject
+      ravmem analyze /my/repo --project myproject --wait
+
+      # Clone mode (server pulls from GitHub)
+      ravmem remote add --git-url https://github.com/org/repo --name myproject
+      ravmem remote clone --project myproject --wait
+      ravmem analyze --project myproject --incremental --wait  # subsequent runs
+
+      # Mount mode (repo already on the server filesystem)
+      ravmem remote add /server/path/repo --name myproject --mount
+      ravmem analyze --project myproject --wait
+    """
 
     repo_path = repo.resolve()
 

ravmem_cli-1.0.0/ravmem/cli/audit.py

@@ -0,0 +1,83 @@
+"""ravmem audit — audit log management commands."""
+
+from __future__ import annotations
+
+from typing import Optional
+
+import typer
+
+from ravmem.cli._common import get_client
+from ravmem.cli._errors import handle_error
+
+
+def audit_list_cmd(
+    limit: int = typer.Option(50, "--limit", "-n", help="Max entries to return"),
+    user: Optional[str] = typer.Option(None, "--user", "-u", help="Filter by user ID"),
+    action: Optional[str] = typer.Option(None, "--action", "-a", help="Filter by action name"),
+    remote: Optional[str] = typer.Option(None, "--remote", help="Server URL override"),
+    output_json: bool = typer.Option(False, "--json", help="Raw JSON output"),
+) -> None:
+    """List audit log entries (admin only)."""
+    import json
+    from rich.console import Console
+    from rich.table import Table
+    from rich import box
+
+    client = get_client(remote)
+    try:
+        entries = client.list_audit(limit=limit, user_id=user, action=action)
+    except Exception as exc:
+        handle_error(exc)
+        raise typer.Exit(1)
+    finally:
+        client.close()
+
+    if output_json:
+        typer.echo(json.dumps(entries, indent=2, default=str))
+        return
+
+    if not entries:
+        typer.echo("No audit entries found.")
+        return
+
+    console = Console()
+    t = Table(box=box.SIMPLE, show_header=True, header_style="bold",
+              title=f"Audit log ({len(entries)} entries)")
+    t.add_column("Time", width=19)
+    t.add_column("User", width=16)
+    t.add_column("Action", width=20)
+    t.add_column("Resource", width=30)
+    t.add_column("Result", width=8)
+
+    for e in entries:
+        result_color = "green" if e.get("result") == "ok" else "red"
+        t.add_row(
+            str(e.get("timestamp", ""))[:19],
+            str(e.get("user_id", ""))[:16],
+            str(e.get("action", ""))[:20],
+            str(e.get("resource", ""))[:30],
+            f"[{result_color}]{e.get('result', '?')}[/{result_color}]",
+        )
+    console.print(t)
+
+
+def audit_rotate_cmd(
+    retain_days: int = typer.Option(90, "--retain-days", help="Keep entries newer than N days"),
+    yes: bool = typer.Option(False, "--yes", "-y", help="Skip confirmation"),
+    remote: Optional[str] = typer.Option(None, "--remote", help="Server URL override"),
+) -> None:
+    """Rotate audit logs, discarding entries older than --retain-days (admin only)."""
+    if not yes:
+        typer.confirm(f"Rotate audit log (keep last {retain_days} days)?", abort=True)
+
+    client = get_client(remote)
+    try:
+        result = client.rotate_audit()
+    except Exception as exc:
+        handle_error(exc)
+        raise typer.Exit(1)
+    finally:
+        client.close()
+
+    removed = result.get("removed", result.get("deleted", "?"))
+    typer.echo(f"Audit log rotated. Entries removed: {removed}")