cortexdb-cli 0.2.0__py3-none-any.whl → 0.4.0__py3-none-any.whl

cortexdb_cli/__init__.py

@@ -1,3 +1,3 @@
 """CortexDB CLI — command-line interface for the v1 memory API."""
 
-__version__ = "0.2.0"
+__version__ = "0.4.0"

cortexdb_cli/client.py

@@ -1,92 +1,92 @@
-"""HTTP client for the CortexDB v1 API.
-
-Thin wrapper around httpx that reads credentials + endpoint from the CLI
-context and stamps every request with both `Authorization: Bearer …` and
-`X-Cortex-Actor: …`. The actor header is mandatory on v1 — missing it
-returns 401 ACTOR_MISMATCH no matter how valid the token is.
-
-We deliberately don't depend on the cortexdbai SDK: keeping the CLI a
-straight HTTP client makes the install fast and lets us pin httpx
-independently from the SDK's release cadence.
-"""
-
-from __future__ import annotations
-
-from contextlib import contextmanager
-from typing import Any, Generator
-
-import httpx
-
-from cortexdb_cli import __version__
-
-DEFAULT_ENDPOINT = "https://api-v1.cortexdb.ai"
-
-
-class CortexClient:
-    """Synchronous HTTP client for the CortexDB v1 API."""
-
-    def __init__(
-        self,
-        endpoint: str,
-        api_key: str,
-        actor: str = "",
-        timeout: float = 30.0,
-    ) -> None:
-        self.endpoint = endpoint.rstrip("/")
-        self.api_key = api_key
-        self.actor = actor
-        headers: dict[str, str] = {
-            "Content-Type": "application/json",
-            "User-Agent": f"cortexdb-cli/{__version__}",
-        }
-        if api_key:
-            headers["Authorization"] = f"Bearer {api_key}"
-        if actor:
-            headers["X-Cortex-Actor"] = actor
-        self._http = httpx.Client(
-            base_url=self.endpoint,
-            headers=headers,
-            timeout=timeout,
-        )
-
-    def close(self) -> None:
-        self._http.close()
-
-    def get(self, path: str, params: dict[str, Any] | None = None) -> httpx.Response:
-        return self._http.get(path, params=params)
-
-    def post(
-        self,
-        path: str,
-        json: dict[str, Any] | None = None,
-        params: dict[str, Any] | None = None,
-    ) -> httpx.Response:
-        return self._http.post(path, json=json, params=params)
-
-    def delete(self, path: str, params: dict[str, Any] | None = None) -> httpx.Response:
-        return self._http.delete(path, params=params)
-
-
-def signup(endpoint: str = DEFAULT_ENDPOINT, timeout: float = 30.0) -> dict[str, Any]:
-    """Call POST /v1/auth/signup and return {token, user_id, scope, expires_at, tier}.
-
-    The endpoint is public — no auth required. Free tier; 7-day TTL.
-    """
-    with httpx.Client(timeout=timeout) as http:
-        resp = http.post(f"{endpoint.rstrip('/')}/v1/auth/signup", json={})
-        resp.raise_for_status()
-        return resp.json()
-
-
-@contextmanager
-def get_client(ctx: dict[str, Any]) -> Generator[CortexClient, None, None]:
-    """Create a CortexClient from CLI context."""
-    client = CortexClient(
-        endpoint=ctx.get("endpoint", DEFAULT_ENDPOINT),
-        api_key=ctx.get("api_key", ""),
-        actor=ctx.get("actor", ""),
-    )
-    try:
-        yield client
-    finally:
-        client.close()
+"""HTTP client for the CortexDB v1 API.
+
+Thin wrapper around httpx that reads credentials + endpoint from the CLI
+context and stamps every request with both `Authorization: Bearer …` and
+`X-Cortex-Actor: …`. The actor header is mandatory on v1 — missing it
+returns 401 ACTOR_MISMATCH no matter how valid the token is.
+
+We deliberately don't depend on the cortexdbai SDK: keeping the CLI a
+straight HTTP client makes the install fast and lets us pin httpx
+independently from the SDK's release cadence.
+"""
+
+from __future__ import annotations
+
+from contextlib import contextmanager
+from typing import Any, Generator
+
+import httpx
+
+from cortexdb_cli import __version__
+
+DEFAULT_ENDPOINT = "https://api-v1.cortexdb.ai"
+
+
+class CortexClient:
+    """Synchronous HTTP client for the CortexDB v1 API."""
+
+    def __init__(
+        self,
+        endpoint: str,
+        api_key: str,
+        actor: str = "",
+        timeout: float = 30.0,
+    ) -> None:
+        self.endpoint = endpoint.rstrip("/")
+        self.api_key = api_key
+        self.actor = actor
+        headers: dict[str, str] = {
+            "Content-Type": "application/json",
+            "User-Agent": f"cortexdb-cli/{__version__}",
+        }
+        if api_key:
+            headers["Authorization"] = f"Bearer {api_key}"
+        if actor:
+            headers["X-Cortex-Actor"] = actor
+        self._http = httpx.Client(
+            base_url=self.endpoint,
+            headers=headers,
+            timeout=timeout,
+        )
+
+    def close(self) -> None:
+        self._http.close()
+
+    def get(self, path: str, params: dict[str, Any] | None = None) -> httpx.Response:
+        return self._http.get(path, params=params)
+
+    def post(
+        self,
+        path: str,
+        json: dict[str, Any] | None = None,
+        params: dict[str, Any] | None = None,
+    ) -> httpx.Response:
+        return self._http.post(path, json=json, params=params)
+
+    def delete(self, path: str, params: dict[str, Any] | None = None) -> httpx.Response:
+        return self._http.delete(path, params=params)
+
+
+def signup(endpoint: str = DEFAULT_ENDPOINT, timeout: float = 30.0) -> dict[str, Any]:
+    """Call POST /v1/auth/signup and return {token, user_id, scope, expires_at, tier}.
+
+    The endpoint is public — no auth required. Free tier; 7-day TTL.
+    """
+    with httpx.Client(timeout=timeout) as http:
+        resp = http.post(f"{endpoint.rstrip('/')}/v1/auth/signup", json={})
+        resp.raise_for_status()
+        return resp.json()
+
+
+@contextmanager
+def get_client(ctx: dict[str, Any]) -> Generator[CortexClient, None, None]:
+    """Create a CortexClient from CLI context."""
+    client = CortexClient(
+        endpoint=ctx.get("endpoint", DEFAULT_ENDPOINT),
+        api_key=ctx.get("api_key", ""),
+        actor=ctx.get("actor", ""),
+    )
+    try:
+        yield client
+    finally:
+        client.close()

cortexdb_cli/commands/admin.py

@@ -1,83 +1,83 @@
-"""cortexdb admin — health, usage, layer stats."""
-
-from __future__ import annotations
-
-import click
-
-from cortexdb_cli.client import get_client
-from cortexdb_cli.errors import handle_errors
-from cortexdb_cli.output import (
-    is_json_mode,
-    print_health,
-    print_ontology,
-    print_usage,
-    spinner,
-)
-
-
-@click.group("admin")
-def admin_group() -> None:
-    """Diagnostics — reachability, identity, rate-limit, layer status."""
-
-
-@admin_group.command("health")
-@click.pass_context
-@handle_errors
-def admin_health(ctx: click.Context) -> None:
-    """Auth + reachability check (GET /v1/auth/whoami)."""
-    cfg = ctx.obj
-    with get_client(cfg) as client:
-        resp = client.get("/v1/auth/whoami")
-        resp.raise_for_status()
-        body = resp.json()
-        # Normalise into the shape print_health expects.
-        body.setdefault("status", "ok")
-        print_health(body, cfg)
-
-
-@admin_group.command("usage")
-@click.pass_context
-@handle_errors
-def admin_usage(ctx: click.Context) -> None:
-    """Tier, capabilities, rate-limit headroom, token expiry."""
-    cfg = ctx.obj
-    with get_client(cfg) as client:
-        if not is_json_mode(cfg):
-            with spinner("Loading usage..."):
-                resp = client.get("/v1/auth/whoami")
-        else:
-            resp = client.get("/v1/auth/whoami")
-        resp.raise_for_status()
-        body = resp.json()
-        # Fold rate-limit + expiry response headers into the body so the
-        # output formatter can render them in one block.
-        for k in (
-            "X-RateLimit-Limit",
-            "X-RateLimit-Reset",
-            "X-RateLimit-Remaining",
-            "X-Cortex-Token-Expires-In",
-            "X-Cortex-Token-Expires-At",
-        ):
-            if k in resp.headers:
-                body[k] = resp.headers[k]
-        print_usage(body, cfg)
-
-
-@admin_group.command("layers")
-@click.pass_context
-@handle_errors
-def admin_layers(ctx: click.Context) -> None:
-    """Per-layer counts and synthesis lag (GET /v1/admin/layers/stats).
-
-    Stability: experimental — the endpoint is gated by the
-    `admin.layers.stats` capability and may not be present on the free tier.
-    """
-    cfg = ctx.obj
-    with get_client(cfg) as client:
-        if not is_json_mode(cfg):
-            with spinner("Loading layer stats..."):
-                resp = client.get("/v1/admin/layers/stats")
-        else:
-            resp = client.get("/v1/admin/layers/stats")
-        resp.raise_for_status()
-        print_ontology(resp.json(), cfg)
+"""cortexdb admin — health, usage, layer stats."""
+
+from __future__ import annotations
+
+import click
+
+from cortexdb_cli.client import get_client
+from cortexdb_cli.errors import handle_errors
+from cortexdb_cli.output import (
+    is_json_mode,
+    print_health,
+    print_ontology,
+    print_usage,
+    spinner,
+)
+
+
+@click.group("admin")
+def admin_group() -> None:
+    """Diagnostics — reachability, identity, rate-limit, layer status."""
+
+
+@admin_group.command("health")
+@click.pass_context
+@handle_errors
+def admin_health(ctx: click.Context) -> None:
+    """Auth + reachability check (GET /v1/auth/whoami)."""
+    cfg = ctx.obj
+    with get_client(cfg) as client:
+        resp = client.get("/v1/auth/whoami")
+        resp.raise_for_status()
+        body = resp.json()
+        # Normalise into the shape print_health expects.
+        body.setdefault("status", "ok")
+        print_health(body, cfg)
+
+
+@admin_group.command("usage")
+@click.pass_context
+@handle_errors
+def admin_usage(ctx: click.Context) -> None:
+    """Tier, capabilities, rate-limit headroom, token expiry."""
+    cfg = ctx.obj
+    with get_client(cfg) as client:
+        if not is_json_mode(cfg):
+            with spinner("Loading usage..."):
+                resp = client.get("/v1/auth/whoami")
+        else:
+            resp = client.get("/v1/auth/whoami")
+        resp.raise_for_status()
+        body = resp.json()
+        # Fold rate-limit + expiry response headers into the body so the
+        # output formatter can render them in one block.
+        for k in (
+            "X-RateLimit-Limit",
+            "X-RateLimit-Reset",
+            "X-RateLimit-Remaining",
+            "X-Cortex-Token-Expires-In",
+            "X-Cortex-Token-Expires-At",
+        ):
+            if k in resp.headers:
+                body[k] = resp.headers[k]
+        print_usage(body, cfg)
+
+
+@admin_group.command("layers")
+@click.pass_context
+@handle_errors
+def admin_layers(ctx: click.Context) -> None:
+    """Per-layer counts and synthesis lag (GET /v1/admin/layers/stats).
+
+    Stability: experimental — the endpoint is gated by the
+    `admin.layers.stats` capability and may not be present on the free tier.
+    """
+    cfg = ctx.obj
+    with get_client(cfg) as client:
+        if not is_json_mode(cfg):
+            with spinner("Loading layer stats..."):
+                resp = client.get("/v1/admin/layers/stats")
+        else:
+            resp = client.get("/v1/admin/layers/stats")
+        resp.raise_for_status()
+        print_ontology(resp.json(), cfg)

cortexdb_cli/commands/answer.py

@@ -1,98 +1,105 @@
-"""cortexdb answer — POST /v1/answer (recall + LLM answer)."""
-
-from __future__ import annotations
-
-from typing import Any
-
-import click
-
-from cortexdb_cli.client import get_client
-from cortexdb_cli.errors import handle_errors
-from cortexdb_cli.output import console, is_json_mode, print_json, spinner
-
-
-@click.command("answer")
-@click.argument("question")
-@click.option("--scope", "-S", help="Scope path (defaults to your default scope)")
-@click.option(
-    "--view",
-    type=click.Choice(["raw", "granular", "structured", "holistic", "descend"]),
-    default="holistic",
-    show_default=True,
-)
-@click.option("--temporal", help='Natural-language time window, e.g. "last 30 days"')
-@click.option("--answer-model", help="Override the answer model (paid tier only).")
-@click.option(
-    "--diagnostics",
-    type=click.Choice(["none", "summary", "full"]),
-    default="none",
-    show_default=True,
-)
-@click.pass_context
-@handle_errors
-def answer_cmd(
-    ctx: click.Context,
-    question: str,
-    scope: str | None,
-    view: str,
-    temporal: str | None,
-    answer_model: str | None,
-    diagnostics: str,
-) -> None:
-    """Ask a question — server recalls context and an LLM answers it.
-
-    Counts against the tenant's LLM quota. Requires the `llm.invoke`
-    capability (granted by default on every tier including Free).
-
-        cortexdb answer "Did Acme renew?" --temporal "last 30 days"
-    """
-    cfg = ctx.obj
-    target_scope = scope or cfg.get("scope") or cfg.get("actor")
-    if not target_scope:
-        raise click.UsageError(
-            "No scope configured. Run `cortexdb init` first, or pass --scope explicitly."
-        )
-
-    body: dict[str, Any] = {
-        "scope": target_scope,
-        "question": question,
-        "view": view,
-        "diagnostics": diagnostics,
-    }
-    if temporal:
-        body["temporal"] = {"natural": temporal}
-    if answer_model:
-        body["answer_model"] = answer_model
-
-    with get_client(cfg) as client:
-        if not is_json_mode(cfg):
-            with spinner("Answering..."):
-                resp = client.post("/v1/answer", json=body)
-        else:
-            resp = client.post("/v1/answer", json=body)
-        resp.raise_for_status()
-        data = resp.json()
-
-    if is_json_mode(cfg):
-        print_json(data)
-        return
-
-    from rich.markup import escape
-    from rich.panel import Panel
-
-    text = data.get("answer") or data.get("text") or "(no answer returned)"
-    cites = data.get("citations") or []
-
-    console.print(
-        Panel(
-            escape(str(text)),
-            title="[header]Answer[/header]",
-            border_style="cyan",
-            padding=(1, 2),
-        )
-    )
-    if cites:
-        console.print(f"\n[dim]{len(cites)} citation(s):[/dim]")
-        for c in cites[:10]:
-            eid = c.get("event_id") or c.get("id") or ""
-            console.print(f"  [dim]· {escape(eid)}[/dim]")
+"""cortexdb answer — POST /v1/answer (recall + LLM answer)."""
+
+from __future__ import annotations
+
+from typing import Any
+
+import click
+
+from cortexdb_cli.client import get_client
+from cortexdb_cli.errors import handle_errors
+from cortexdb_cli.output import console, is_json_mode, print_json, spinner
+
+
+@click.command("answer")
+@click.argument("question")
+@click.option("--scope", "-S", help="Scope path (defaults to your default scope)")
+@click.option(
+    "--view",
+    type=click.Choice(["raw", "granular", "structured", "holistic", "descend"]),
+    default=None,
+    help="Pack shape used for recall. Defaults to your configured view "
+    "(CORTEXDB_VIEW env or `cortexdb config set view ...`), else 'holistic'. "
+    "Use 'descend' to search the scope + all child scopes.",
+)
+@click.option("--temporal", help='Natural-language time window, e.g. "last 30 days"')
+@click.option("--answer-model", help="Override the answer model (paid tier only).")
+@click.option(
+    "--diagnostics",
+    type=click.Choice(["none", "summary", "full"]),
+    default="none",
+    show_default=True,
+)
+@click.pass_context
+@handle_errors
+def answer_cmd(
+    ctx: click.Context,
+    question: str,
+    scope: str | None,
+    view: str,
+    temporal: str | None,
+    answer_model: str | None,
+    diagnostics: str,
+) -> None:
+    """Ask a question — server recalls context and an LLM answers it.
+
+    Counts against the tenant's LLM quota. Requires the `llm.invoke`
+    capability (granted by default on every tier including Free).
+
+        cortexdb answer "Did Acme renew?" --temporal "last 30 days"
+    """
+    cfg = ctx.obj
+    view = view or cfg.get("view") or "holistic"
+    if view not in ("raw", "granular", "structured", "holistic", "descend"):
+        raise click.UsageError(
+            f"Invalid view {view!r}. Choose: raw, granular, structured, holistic, descend."
+        )
+    target_scope = scope or cfg.get("scope") or cfg.get("actor")
+    if not target_scope:
+        raise click.UsageError(
+            "No scope configured. Run `cortexdb init` first, or pass --scope explicitly."
+        )
+
+    body: dict[str, Any] = {
+        "scope": target_scope,
+        "question": question,
+        "view": view,
+        "diagnostics": diagnostics,
+    }
+    if temporal:
+        body["temporal"] = {"natural": temporal}
+    if answer_model:
+        body["answer_model"] = answer_model
+
+    with get_client(cfg) as client:
+        if not is_json_mode(cfg):
+            with spinner("Answering..."):
+                resp = client.post("/v1/answer", json=body)
+        else:
+            resp = client.post("/v1/answer", json=body)
+        resp.raise_for_status()
+        data = resp.json()
+
+    if is_json_mode(cfg):
+        print_json(data)
+        return
+
+    from rich.markup import escape
+    from rich.panel import Panel
+
+    text = data.get("answer") or data.get("text") or "(no answer returned)"
+    cites = data.get("citations") or []
+
+    console.print(
+        Panel(
+            escape(str(text)),
+            title="[header]Answer[/header]",
+            border_style="cyan",
+            padding=(1, 2),
+        )
+    )
+    if cites:
+        console.print(f"\n[dim]{len(cites)} citation(s):[/dim]")
+        for c in cites[:10]:
+            eid = c.get("event_id") or c.get("id") or ""
+            console.print(f"  [dim]· {escape(eid)}[/dim]")