cortexdb-cli 0.2.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,3 @@
1
+ """CortexDB CLI — command-line interface for the v1 memory API."""
2
+
3
+ __version__ = "0.2.0"
cortexdb_cli/client.py ADDED
@@ -0,0 +1,92 @@
1
+ """HTTP client for the CortexDB v1 API.
2
+
3
+ Thin wrapper around httpx that reads credentials + endpoint from the CLI
4
+ context and stamps every request with both `Authorization: Bearer …` and
5
+ `X-Cortex-Actor: …`. The actor header is mandatory on v1 — missing it
6
+ returns 401 ACTOR_MISMATCH no matter how valid the token is.
7
+
8
+ We deliberately don't depend on the cortexdbai SDK: keeping the CLI a
9
+ straight HTTP client makes the install fast and lets us pin httpx
10
+ independently from the SDK's release cadence.
11
+ """
12
+
13
+ from __future__ import annotations
14
+
15
+ from contextlib import contextmanager
16
+ from typing import Any, Generator
17
+
18
+ import httpx
19
+
20
+ from cortexdb_cli import __version__
21
+
22
+ DEFAULT_ENDPOINT = "https://api-v1.cortexdb.ai"
23
+
24
+
25
+ class CortexClient:
26
+ """Synchronous HTTP client for the CortexDB v1 API."""
27
+
28
+ def __init__(
29
+ self,
30
+ endpoint: str,
31
+ api_key: str,
32
+ actor: str = "",
33
+ timeout: float = 30.0,
34
+ ) -> None:
35
+ self.endpoint = endpoint.rstrip("/")
36
+ self.api_key = api_key
37
+ self.actor = actor
38
+ headers: dict[str, str] = {
39
+ "Content-Type": "application/json",
40
+ "User-Agent": f"cortexdb-cli/{__version__}",
41
+ }
42
+ if api_key:
43
+ headers["Authorization"] = f"Bearer {api_key}"
44
+ if actor:
45
+ headers["X-Cortex-Actor"] = actor
46
+ self._http = httpx.Client(
47
+ base_url=self.endpoint,
48
+ headers=headers,
49
+ timeout=timeout,
50
+ )
51
+
52
+ def close(self) -> None:
53
+ self._http.close()
54
+
55
+ def get(self, path: str, params: dict[str, Any] | None = None) -> httpx.Response:
56
+ return self._http.get(path, params=params)
57
+
58
+ def post(
59
+ self,
60
+ path: str,
61
+ json: dict[str, Any] | None = None,
62
+ params: dict[str, Any] | None = None,
63
+ ) -> httpx.Response:
64
+ return self._http.post(path, json=json, params=params)
65
+
66
+ def delete(self, path: str, params: dict[str, Any] | None = None) -> httpx.Response:
67
+ return self._http.delete(path, params=params)
68
+
69
+
70
+ def signup(endpoint: str = DEFAULT_ENDPOINT, timeout: float = 30.0) -> dict[str, Any]:
71
+ """Call POST /v1/auth/signup and return {token, user_id, scope, expires_at, tier}.
72
+
73
+ The endpoint is public — no auth required. Free tier; 7-day TTL.
74
+ """
75
+ with httpx.Client(timeout=timeout) as http:
76
+ resp = http.post(f"{endpoint.rstrip('/')}/v1/auth/signup", json={})
77
+ resp.raise_for_status()
78
+ return resp.json()
79
+
80
+
81
+ @contextmanager
82
+ def get_client(ctx: dict[str, Any]) -> Generator[CortexClient, None, None]:
83
+ """Create a CortexClient from CLI context."""
84
+ client = CortexClient(
85
+ endpoint=ctx.get("endpoint", DEFAULT_ENDPOINT),
86
+ api_key=ctx.get("api_key", ""),
87
+ actor=ctx.get("actor", ""),
88
+ )
89
+ try:
90
+ yield client
91
+ finally:
92
+ client.close()
@@ -0,0 +1 @@
1
+ """CortexDB CLI command modules."""
@@ -0,0 +1,83 @@
1
+ """cortexdb admin — health, usage, layer stats."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import click
6
+
7
+ from cortexdb_cli.client import get_client
8
+ from cortexdb_cli.errors import handle_errors
9
+ from cortexdb_cli.output import (
10
+ is_json_mode,
11
+ print_health,
12
+ print_ontology,
13
+ print_usage,
14
+ spinner,
15
+ )
16
+
17
+
18
+ @click.group("admin")
19
+ def admin_group() -> None:
20
+ """Diagnostics — reachability, identity, rate-limit, layer status."""
21
+
22
+
23
+ @admin_group.command("health")
24
+ @click.pass_context
25
+ @handle_errors
26
+ def admin_health(ctx: click.Context) -> None:
27
+ """Auth + reachability check (GET /v1/auth/whoami)."""
28
+ cfg = ctx.obj
29
+ with get_client(cfg) as client:
30
+ resp = client.get("/v1/auth/whoami")
31
+ resp.raise_for_status()
32
+ body = resp.json()
33
+ # Normalise into the shape print_health expects.
34
+ body.setdefault("status", "ok")
35
+ print_health(body, cfg)
36
+
37
+
38
+ @admin_group.command("usage")
39
+ @click.pass_context
40
+ @handle_errors
41
+ def admin_usage(ctx: click.Context) -> None:
42
+ """Tier, capabilities, rate-limit headroom, token expiry."""
43
+ cfg = ctx.obj
44
+ with get_client(cfg) as client:
45
+ if not is_json_mode(cfg):
46
+ with spinner("Loading usage..."):
47
+ resp = client.get("/v1/auth/whoami")
48
+ else:
49
+ resp = client.get("/v1/auth/whoami")
50
+ resp.raise_for_status()
51
+ body = resp.json()
52
+ # Fold rate-limit + expiry response headers into the body so the
53
+ # output formatter can render them in one block.
54
+ for k in (
55
+ "X-RateLimit-Limit",
56
+ "X-RateLimit-Reset",
57
+ "X-RateLimit-Remaining",
58
+ "X-Cortex-Token-Expires-In",
59
+ "X-Cortex-Token-Expires-At",
60
+ ):
61
+ if k in resp.headers:
62
+ body[k] = resp.headers[k]
63
+ print_usage(body, cfg)
64
+
65
+
66
+ @admin_group.command("layers")
67
+ @click.pass_context
68
+ @handle_errors
69
+ def admin_layers(ctx: click.Context) -> None:
70
+ """Per-layer counts and synthesis lag (GET /v1/admin/layers/stats).
71
+
72
+ Stability: experimental — the endpoint is gated by the
73
+ `admin.layers.stats` capability and may not be present on the free tier.
74
+ """
75
+ cfg = ctx.obj
76
+ with get_client(cfg) as client:
77
+ if not is_json_mode(cfg):
78
+ with spinner("Loading layer stats..."):
79
+ resp = client.get("/v1/admin/layers/stats")
80
+ else:
81
+ resp = client.get("/v1/admin/layers/stats")
82
+ resp.raise_for_status()
83
+ print_ontology(resp.json(), cfg)
@@ -0,0 +1,98 @@
1
+ """cortexdb answer — POST /v1/answer (recall + LLM answer)."""
2
+
3
+ from __future__ import annotations
4
+
5
+ from typing import Any
6
+
7
+ import click
8
+
9
+ from cortexdb_cli.client import get_client
10
+ from cortexdb_cli.errors import handle_errors
11
+ from cortexdb_cli.output import console, is_json_mode, print_json, spinner
12
+
13
+
14
+ @click.command("answer")
15
+ @click.argument("question")
16
+ @click.option("--scope", "-S", help="Scope path (defaults to your default scope)")
17
+ @click.option(
18
+ "--view",
19
+ type=click.Choice(["raw", "granular", "structured", "holistic", "descend"]),
20
+ default="holistic",
21
+ show_default=True,
22
+ )
23
+ @click.option("--temporal", help='Natural-language time window, e.g. "last 30 days"')
24
+ @click.option("--answer-model", help="Override the answer model (paid tier only).")
25
+ @click.option(
26
+ "--diagnostics",
27
+ type=click.Choice(["none", "summary", "full"]),
28
+ default="none",
29
+ show_default=True,
30
+ )
31
+ @click.pass_context
32
+ @handle_errors
33
+ def answer_cmd(
34
+ ctx: click.Context,
35
+ question: str,
36
+ scope: str | None,
37
+ view: str,
38
+ temporal: str | None,
39
+ answer_model: str | None,
40
+ diagnostics: str,
41
+ ) -> None:
42
+ """Ask a question — server recalls context and an LLM answers it.
43
+
44
+ Counts against the tenant's LLM quota. Requires the `llm.invoke`
45
+ capability (granted by default on every tier including Free).
46
+
47
+ cortexdb answer "Did Acme renew?" --temporal "last 30 days"
48
+ """
49
+ cfg = ctx.obj
50
+ target_scope = scope or cfg.get("scope") or cfg.get("actor")
51
+ if not target_scope:
52
+ raise click.UsageError(
53
+ "No scope configured. Run `cortexdb init` first, or pass --scope explicitly."
54
+ )
55
+
56
+ body: dict[str, Any] = {
57
+ "scope": target_scope,
58
+ "question": question,
59
+ "view": view,
60
+ "diagnostics": diagnostics,
61
+ }
62
+ if temporal:
63
+ body["temporal"] = {"natural": temporal}
64
+ if answer_model:
65
+ body["answer_model"] = answer_model
66
+
67
+ with get_client(cfg) as client:
68
+ if not is_json_mode(cfg):
69
+ with spinner("Answering..."):
70
+ resp = client.post("/v1/answer", json=body)
71
+ else:
72
+ resp = client.post("/v1/answer", json=body)
73
+ resp.raise_for_status()
74
+ data = resp.json()
75
+
76
+ if is_json_mode(cfg):
77
+ print_json(data)
78
+ return
79
+
80
+ from rich.markup import escape
81
+ from rich.panel import Panel
82
+
83
+ text = data.get("answer") or data.get("text") or "(no answer returned)"
84
+ cites = data.get("citations") or []
85
+
86
+ console.print(
87
+ Panel(
88
+ escape(str(text)),
89
+ title="[header]Answer[/header]",
90
+ border_style="cyan",
91
+ padding=(1, 2),
92
+ )
93
+ )
94
+ if cites:
95
+ console.print(f"\n[dim]{len(cites)} citation(s):[/dim]")
96
+ for c in cites[:10]:
97
+ eid = c.get("event_id") or c.get("id") or ""
98
+ console.print(f" [dim]· {escape(eid)}[/dim]")
@@ -0,0 +1,128 @@
1
+ """cortexdb auth — /v1/auth/{whoami,signup,tokens,revoke}."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import click
6
+
7
+ from cortexdb_cli.client import DEFAULT_ENDPOINT, get_client, signup as signup_call
8
+ from cortexdb_cli.config import config_path, save_config
9
+ from cortexdb_cli.errors import handle_errors
10
+ from cortexdb_cli.output import console, is_json_mode, print_json, print_health, spinner
11
+ from cortexdb_cli.state import save_state, state_path
12
+
13
+
14
+ @click.group("auth")
15
+ def auth_group() -> None:
16
+ """Identity, token mint, revoke, anonymous signup."""
17
+
18
+
19
+ @auth_group.command("whoami")
20
+ @click.pass_context
21
+ @handle_errors
22
+ def auth_whoami(ctx: click.Context) -> None:
23
+ """GET /v1/auth/whoami — caller, tenant, effective capabilities."""
24
+ cfg = ctx.obj
25
+ with get_client(cfg) as client:
26
+ resp = client.get("/v1/auth/whoami")
27
+ resp.raise_for_status()
28
+ body = resp.json()
29
+ body.setdefault("status", "ok")
30
+ print_health(body, cfg)
31
+
32
+
33
+ @auth_group.command("signup")
34
+ @click.option(
35
+ "--endpoint",
36
+ default=DEFAULT_ENDPOINT,
37
+ show_default=True,
38
+ help="CortexDB v1 API base URL.",
39
+ )
40
+ @click.option("--save", "save_state_flag", is_flag=True, help="Persist to ~/.cortexdb/state.json")
41
+ @click.pass_context
42
+ @handle_errors
43
+ def auth_signup(ctx: click.Context, endpoint: str, save_state_flag: bool) -> None:
44
+ """POST /v1/auth/signup — anonymous free-tier token.
45
+
46
+ Without --save, prints the response and exits — useful when you want
47
+ to feed the token into a CI env var. With --save, behaves like
48
+ `cortexdb init` and writes ~/.cortexdb/state.json.
49
+ """
50
+ resp = signup_call(endpoint)
51
+ if save_state_flag:
52
+ save_state(
53
+ {
54
+ "token": resp["token"],
55
+ "user_id": resp["user_id"],
56
+ "scope": resp.get("scope") or resp["user_id"],
57
+ "expires_at": resp.get("expires_at"),
58
+ "tier": resp.get("tier", "free"),
59
+ "source": "signup",
60
+ }
61
+ )
62
+ save_config("default", {"endpoint": endpoint})
63
+ if is_json_mode(ctx.obj):
64
+ print_json(resp)
65
+ else:
66
+ console.print(
67
+ f"[success]Saved state[/success] to {state_path()}\n"
68
+ f" Actor: {resp['user_id']}\n"
69
+ f" Scope: {resp.get('scope') or resp['user_id']}\n"
70
+ f" Expires: {resp.get('expires_at', '?')}"
71
+ )
72
+ else:
73
+ print_json(resp)
74
+
75
+
76
+ @auth_group.command("tokens")
77
+ @click.option("--subject", required=True, help="`sub` claim on the minted token, e.g. user:alice")
78
+ @click.option(
79
+ "--ttl",
80
+ "ttl_seconds",
81
+ type=int,
82
+ default=3600,
83
+ show_default=True,
84
+ help="Token lifetime in seconds (server enforces a tenant ceiling).",
85
+ )
86
+ @click.option("--scope", "scopes", multiple=True, help="`scopes` claim — repeat for multiple.")
87
+ @click.pass_context
88
+ @handle_errors
89
+ def auth_tokens(
90
+ ctx: click.Context, subject: str, ttl_seconds: int, scopes: tuple[str, ...]
91
+ ) -> None:
92
+ """POST /v1/auth/tokens — mint a service-account token.
93
+
94
+ Requires the `auth.mint` capability. Free-tier anonymous tokens do not
95
+ have it — you must hold an IdP-issued token (or a token previously
96
+ minted by an account that does).
97
+
98
+ cortexdb auth tokens --subject user:alice --ttl 3600 --scope org:acme/user:alice
99
+ """
100
+ cfg = ctx.obj
101
+ body: dict[str, object] = {"subject": subject, "ttl_seconds": ttl_seconds}
102
+ if scopes:
103
+ body["scopes"] = list(scopes)
104
+ with get_client(cfg) as client:
105
+ if not is_json_mode(cfg):
106
+ with spinner("Minting..."):
107
+ resp = client.post("/v1/auth/tokens", json=body)
108
+ else:
109
+ resp = client.post("/v1/auth/tokens", json=body)
110
+ resp.raise_for_status()
111
+ print_json(resp.json())
112
+
113
+
114
+ @auth_group.command("revoke")
115
+ @click.option("--jti", required=True, help="Token jti claim to add to the revocation list.")
116
+ @click.option("--reason", required=True, help="Audit reason (e.g. 'token leaked').")
117
+ @click.pass_context
118
+ @handle_errors
119
+ def auth_revoke(ctx: click.Context, jti: str, reason: str) -> None:
120
+ """POST /v1/auth/revoke — invalidate a token by jti."""
121
+ cfg = ctx.obj
122
+ with get_client(cfg) as client:
123
+ resp = client.post("/v1/auth/revoke", json={"jti": jti, "reason": reason})
124
+ resp.raise_for_status()
125
+ if is_json_mode(cfg):
126
+ print_json({"revoked": jti})
127
+ else:
128
+ console.print(f"[success]Revoked[/success] jti={jti}")
@@ -0,0 +1,121 @@
1
+ """cortexdb beliefs — GET /v1/beliefs + /v1/beliefs/why + POST /v1/beliefs/build."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import click
6
+
7
+ from cortexdb_cli.client import get_client
8
+ from cortexdb_cli.errors import handle_errors
9
+ from cortexdb_cli.output import (
10
+ console,
11
+ escape,
12
+ is_json_mode,
13
+ print_json,
14
+ spinner,
15
+ )
16
+
17
+
18
+ @click.group("beliefs")
19
+ def beliefs_group() -> None:
20
+ """Beliefs — aggregated, confidence-weighted views over facts."""
21
+
22
+
23
+ def _scope_or_die(cfg: dict, scope: str | None) -> str:
24
+ s = scope or cfg.get("scope") or cfg.get("actor")
25
+ if not s:
26
+ raise click.UsageError(
27
+ "No scope configured. Run `cortexdb init` first, or pass --scope explicitly."
28
+ )
29
+ return s
30
+
31
+
32
+ @beliefs_group.command("list")
33
+ @click.option("--scope", "-S", help="Scope path (defaults to your default scope)")
34
+ @click.option("--limit", "-l", default=50, show_default=True)
35
+ @click.pass_context
36
+ @handle_errors
37
+ def beliefs_list(ctx: click.Context, scope: str | None, limit: int) -> None:
38
+ """List active beliefs in a scope."""
39
+ cfg = ctx.obj
40
+ s = _scope_or_die(cfg, scope)
41
+ with get_client(cfg) as client:
42
+ if not is_json_mode(cfg):
43
+ with spinner("Loading beliefs..."):
44
+ resp = client.get("/v1/beliefs", params={"scope": s, "limit": limit})
45
+ else:
46
+ resp = client.get("/v1/beliefs", params={"scope": s, "limit": limit})
47
+ resp.raise_for_status()
48
+
49
+ data = resp.json()
50
+ if is_json_mode(cfg):
51
+ print_json(data)
52
+ return
53
+
54
+ items = data.get("items", data) if isinstance(data, dict) else data
55
+ if not items:
56
+ console.print(
57
+ "[dim]No beliefs yet — the consolidator builds these from facts asynchronously.[/dim]"
58
+ )
59
+ return
60
+
61
+ from rich.table import Table
62
+
63
+ table = Table(title="[header]Beliefs[/header]", border_style="blue")
64
+ table.add_column("Belief ID", style="dim", max_width=16)
65
+ table.add_column("Predicate", style="magenta", max_width=24)
66
+ table.add_column("Object", style="bold")
67
+ table.add_column("Conf", justify="right", width=6)
68
+ table.add_column("Support", justify="right", width=8)
69
+ for b in items:
70
+ table.add_row(
71
+ escape(str(b.get("belief_id") or b.get("id", ""))[:16]),
72
+ escape(str(b.get("predicate", ""))),
73
+ escape(str(b.get("object", ""))),
74
+ f"{(b.get('confidence') or 0):.0%}",
75
+ str(b.get("support_count") or len(b.get("supports") or [])),
76
+ )
77
+ console.print(table)
78
+
79
+
80
+ @beliefs_group.command("why")
81
+ @click.argument("belief_id")
82
+ @click.pass_context
83
+ @handle_errors
84
+ def beliefs_why(ctx: click.Context, belief_id: str) -> None:
85
+ """Show the facts + events that ground a belief.
86
+
87
+ cortexdb beliefs why belief_01HX...
88
+ """
89
+ cfg = ctx.obj
90
+ with get_client(cfg) as client:
91
+ if not is_json_mode(cfg):
92
+ with spinner("Tracing provenance..."):
93
+ resp = client.get("/v1/beliefs/why", params={"belief_id": belief_id})
94
+ else:
95
+ resp = client.get("/v1/beliefs/why", params={"belief_id": belief_id})
96
+ resp.raise_for_status()
97
+ print_json(resp.json())
98
+
99
+
100
+ @beliefs_group.command("build")
101
+ @click.option("--scope", "-S", help="Scope path (defaults to your default scope)")
102
+ @click.pass_context
103
+ @handle_errors
104
+ def beliefs_build(ctx: click.Context, scope: str | None) -> None:
105
+ """Trigger an on-demand belief rebuild for a scope.
106
+
107
+ Useful right after a large `experience bulk` ingest if you don't want
108
+ to wait for the next scheduler tick.
109
+ """
110
+ cfg = ctx.obj
111
+ s = _scope_or_die(cfg, scope)
112
+ with get_client(cfg) as client:
113
+ resp = client.post("/v1/beliefs/build", json={"scope": s})
114
+ resp.raise_for_status()
115
+ if is_json_mode(cfg):
116
+ print_json(resp.json())
117
+ else:
118
+ console.print(
119
+ "[success]Belief build scheduled[/success] — check back with "
120
+ "[bold]cortexdb beliefs list[/bold] in a minute or two."
121
+ )
@@ -0,0 +1,50 @@
1
+ """cortexdb config -- View and edit configuration."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import click
6
+
7
+ from cortexdb_cli.config import config_path, load_config, save_config
8
+ from cortexdb_cli.output import console, print_json, is_json_mode
9
+
10
+
11
+ @click.group("config")
12
+ def config_group() -> None:
13
+ """View and manage CLI configuration."""
14
+
15
+
16
+ @config_group.command("show")
17
+ @click.pass_context
18
+ def config_show(ctx: click.Context) -> None:
19
+ """Show current configuration."""
20
+ cfg = load_config()
21
+ if is_json_mode(ctx.obj):
22
+ # Redact API key in JSON output
23
+ safe = dict(cfg)
24
+ if "api_key" in safe:
25
+ key = safe["api_key"]
26
+ safe["api_key"] = key[:8] + "..." + key[-4:] if len(key) > 12 else "***"
27
+ print_json(safe)
28
+ else:
29
+ console.print(f"[dim]Config file: {config_path()}[/dim]\n")
30
+ for k, v in cfg.items():
31
+ if k == "api_key" and v:
32
+ v = v[:8] + "..." + v[-4:] if len(v) > 12 else "***"
33
+ console.print(f" [bold]{k}[/bold] = {v}")
34
+ console.print()
35
+
36
+
37
+ @config_group.command("set")
38
+ @click.argument("key")
39
+ @click.argument("value")
40
+ def config_set(key: str, value: str) -> None:
41
+ """Set a configuration value.
42
+
43
+ cortexdb config set api_key cx_live_...
44
+
45
+ cortexdb config set endpoint https://api.cortexdb.ai
46
+ """
47
+ cfg = load_config()
48
+ cfg[key] = value
49
+ save_config("default", cfg)
50
+ console.print(f"[success]Set {key}[/success]")