File size: 68,031 Bytes
5e3d88d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 | """`sibyl` command-line interface.
Stdlib only. The CLI is a thin wrapper around HTTP calls to
https://api.sibyllabs.org/api/plugin/* and the local SibylMemoryProvider.
Design pillars:
- Zero non-stdlib deps in this file. urllib is enough.
- Credentials are written atomically at mode 0600, set at file-creation
time via O_CREAT|O_EXCL|O_NOFOLLOW (no chmod-after-write race).
- The URL parameter handed to the browser is an opaque session identifier,
not the long-lived bearer (audit SEC-1 β server-side pairing handoff
issues a separate bearer at activation completion if available).
- session_token is never printed in full β display short slice only.
- Polling has explicit timeouts; no infinite loops.
- Every command exits with a clear status code (0 ok, 1 user error, 2 server error).
"""
from __future__ import annotations
import argparse
import hashlib
import json
import os
import secrets
import sys
import time
import urllib.error
import urllib.parse
import urllib.request
import uuid
import webbrowser
from pathlib import Path
from typing import Any
def _client_version() -> str:
"""Return the installed package version from metadata, never hardcoded."""
try:
from importlib.metadata import PackageNotFoundError, version as _v
try:
return _v("sibyl-memory-cli")
except PackageNotFoundError:
return "0.0.0+source"
except Exception:
return "0.0.0+source"
# ---- Defaults ----------------------------------------------------------
API_BASE = os.environ.get("SIBYL_API_BASE", "https://api.sibyllabs.org")
# Dedicated short-URL auth subdomain (2026-05-20). Trust + phishing resistance:
# the URL the user sees in their terminal + browser is purpose-specific and
# short enough to read at a glance. Legacy URL `sibyllabs.org/plugin/activate
# ?session=<uuid>` still resolves so older CLI installs continue to work.
ACTIVATE_BASE = os.environ.get("SIBYL_ACTIVATE_BASE", "https://auth.sibyllabs.org")
UPGRADE_BASE = os.environ.get("SIBYL_UPGRADE_BASE", "https://sibyllabs.org/plugin/upgrade")
DEFAULT_CRED_PATH = Path("~/.sibyl-memory/credentials.json").expanduser()
DEFAULT_DB_PATH = Path("~/.sibyl-memory/memory.db").expanduser()
DEFAULT_TIER_CACHE_PATH = Path("~/.sibyl-memory/tier_cache.json").expanduser()
POLL_INTERVAL_SEC = 3
# v0.3.5 fix: the CLI no longer carries its own activation deadline. The
# server's /session-init response includes pairing_ttl_seconds β the CLI
# polls until that timestamp, deferring to the server as the single source
# of truth. The constants below are fallbacks only, used when session-init
# fails to return a value (network error, schema drift). Drift between CLI
# and server is now impossible by construction; the prior 10min/15min
# silent-success gap can't recur because there is no CLI-side number to
# diverge from the server's.
INIT_TIMEOUT_FALLBACK_SEC = 30 * 60 # used only if session-init returns no TTL
UPGRADE_TIMEOUT_SEC = 30 * 60 # upgrade flow uses local constant β no server handshake to defer to
# ---- Color / output ----------------------------------------------------
from . import _aesthetic as a
_NO_COLOR = bool(os.environ.get("NO_COLOR")) or not sys.stdout.isatty()
def c(code: str, s: str) -> str:
if _NO_COLOR:
return s
return f"\033[{code}m{s}\033[0m"
def dim(s: str) -> str: return c("2", s)
def bold(s: str) -> str: return c("1", s)
def green(s: str) -> str: return c("32", s)
def yellow(s: str) -> str: return c("33", s)
def red(s: str) -> str: return c("31", s)
def cyan(s: str) -> str: return c("36", s)
def _detect_os_family() -> str | None:
p = sys.platform
if p == "darwin": return "macos"
if p.startswith("linux"): return "linux"
if p.startswith("win"): return "windows"
return None
def short(token: str | None) -> str:
if not token:
return "β"
if len(token) <= 12:
return token
return f"{token[:8]}β¦{token[-4:]}"
def print_status(label: str, value: str) -> None:
print(f" {dim(label.ljust(18))} {value}")
def _fmt_cap_bytes(cap: Any) -> str:
"""Render a server-supplied cap_bytes value defensively.
CLI-16: `cap_bytes` is None for unlimited, otherwise an int. A non-int,
non-None value (e.g. a string from a buggy/old server) would raise on the
`:,` format spec. Coerce to int when possible; show the raw value rather
than crash when it can't be coerced."""
if cap is None:
return "unlimited"
try:
return f"{int(cap):,}"
except (TypeError, ValueError):
return str(cap)
# ---- HTTP --------------------------------------------------------------
class HttpError(Exception):
def __init__(self, status: int, body: Any, url: str) -> None:
super().__init__(f"HTTP {status} for {url}: {body}")
self.status = status
self.body = body
self.url = url
def http_request( # noqa: D401
method: str,
path: str,
*,
body: dict | None = None,
timeout: float = 15.0,
headers: dict | None = None,
) -> dict:
"""Single source of truth for HTTP calls. Returns parsed JSON or raises HttpError."""
url = f"{API_BASE}{path}"
data = None
full_headers = {"Accept": "application/json", "User-Agent": f"sibyl-memory-cli/{_client_version()}"}
if body is not None:
data = json.dumps(body).encode("utf-8")
full_headers["Content-Type"] = "application/json"
if headers:
full_headers.update(headers)
req = urllib.request.Request(url, data=data, method=method, headers=full_headers)
try:
with urllib.request.urlopen(req, timeout=timeout) as resp:
return json.loads(resp.read().decode("utf-8"))
except urllib.error.HTTPError as e:
try:
err_body = json.loads(e.read().decode("utf-8"))
except Exception:
err_body = {"error": "unparseable response body"}
raise HttpError(e.code, err_body, url) from None
except urllib.error.URLError as e:
raise HttpError(0, {"error": str(e.reason)}, url) from None
# ---- Credentials I/O ---------------------------------------------------
def write_credentials_atomic(creds: dict, path: Path = DEFAULT_CRED_PATH) -> Path:
"""Write credentials.json atomically at mode 0600.
v0.1.2 hardening (audit SEC-2): mode 0600 is set by the kernel at
file-creation time via O_CREAT|O_EXCL|O_NOFOLLOW. Previously used
write_text() followed by os.chmod(), leaving a world-readable window
between syscalls every credential save.
"""
path = path.expanduser()
path.parent.mkdir(parents=True, exist_ok=True, mode=0o700)
# mkdir's mode is ignored when the dir already exists (bug, dor_alpha 2026-06-01):
# a pre-existing 0755 ~/.sibyl-memory left credentials world-readable. Tighten
# explicitly to cover the pre-existing-directory case.
try:
os.chmod(path.parent, 0o700)
except OSError:
pass
data = json.dumps(creds, indent=2).encode("utf-8")
# v0.3.17 hardening (audit CLI-2): unique per-process temp via
# tempfile.mkstemp instead of the fixed `<name>.tmp` + unlink dance.
# The old approach unlinked a leftover temp and then re-created it with
# O_EXCL β a TOCTOU window where two concurrent writers (or an attacker
# who recreated the path between unlink and open) could collide. mkstemp
# picks a name no other process holds and opens it O_CREAT|O_EXCL itself,
# so no unlink is needed. We still enforce mode 0600 (fchmod, since mkstemp
# honors the process umask) and fsync before the atomic replace.
import tempfile
fd, tmp = tempfile.mkstemp(dir=str(path.parent), prefix=path.name + ".", suffix=".tmp")
try:
os.fchmod(fd, 0o600)
os.write(fd, data)
os.fsync(fd)
except BaseException:
os.close(fd)
try:
os.unlink(tmp)
except OSError:
pass
raise
else:
os.close(fd)
os.replace(tmp, str(path))
return path
def read_credentials(path: Path = DEFAULT_CRED_PATH) -> dict | None:
"""Read credentials.json.
v0.1.2 hardening (audit SEC-11): refuses to follow symlinks.
Returns None if the file is a symlink or doesn't exist."""
path = path.expanduser()
if not path.exists():
return None
if path.is_symlink():
return None
# v0.3.17 hardening (audit CLI-1 / submitter D1): a corrupt or unreadable
# credentials.json must surface a clean one-liner, not a raw traceback.
try:
return json.loads(path.read_text(encoding="utf-8"))
except (ValueError, OSError):
print(red("credentials.json is corrupt or unreadable. Run `sibyl init --force` to re-activate."))
return None
def invalidate_tier_cache(path: Path = DEFAULT_TIER_CACHE_PATH) -> None:
"""Drop the local tier cache so the next write refreshes against the server."""
path = path.expanduser()
if path.exists():
path.unlink()
def is_sqlite_db(path: Path) -> bool:
"""Lightweight check that `path` is a real SQLite database.
v0.3.17 (audit CLI-3 / submitter D3): `sibyl status --db <garbage>` used to
report a non-SQLite file as if it were a normal DB. We check the 16-byte
SQLite header magic, then confirm the file opens and answers a trivial
PRAGMA. A 0-byte file is a valid (empty) SQLite database, so it passes.
Returns False on any read/parse error rather than raising."""
import sqlite3
try:
if not path.exists() or not path.is_file():
return False
size = path.stat().st_size
if size == 0:
return True # empty file is a valid, freshly-created SQLite DB
with open(path, "rb") as fh:
header = fh.read(16)
if header != b"SQLite format 3\x00":
return False
con = sqlite3.connect(str(path))
try:
con.execute("PRAGMA schema_version")
finally:
con.close()
return True
except (OSError, sqlite3.Error):
return False
# ---- `sibyl init` ------------------------------------------------------
def _gen_pairing_code() -> str:
"""6-digit cryptographic pairing code. Uniform across 000000-999999."""
return f"{secrets.randbelow(1_000_000):06d}"
def _hash_pairing_code(code: str, session: str) -> str:
return hashlib.sha256(f"{code}:{session}".encode("utf-8")).hexdigest()
def cmd_init(args: argparse.Namespace) -> int:
"""Activation flow. Generate session UUID + pairing code, register with
server, open activation page in browser, poll /check until bound.
The pairing code is printed in the terminal. If the user picks the
email path in the browser, they type both their email and this code.
No external email service is required."""
# Brand moment β gold/white gradient SIBYL wordmark.
# Honors NO_COLOR + TTY detection automatically; safe to always call.
from ._banner import print_banner
print_banner()
cred_path = Path(args.credentials).expanduser()
if cred_path.exists() and not args.force:
existing = read_credentials(cred_path) or {}
print(a.section_header("already activated", subtitle="use --force to re-activate"))
print()
print(a.kv("Account", short(existing.get("account_id"))))
print(a.kv("Tier", (existing.get("tier") or "free").upper(), value_color="accent"))
print(a.kv("Credentials", str(cred_path)))
print()
return 0
# SEC-1 mitigation (v0.1.2): the URL parameter is an opaque pairing
# session identifier, NOT the long-lived bearer used by /access and
# /check-write. The CLI generates it locally and the server treats
# it as the activation rendezvous key only. The persistent bearer
# is issued by the server in the /check response (`bearer_token`
# field) after activation completes. Servers running pre-SEC-1
# firmware that echo the URL identifier as the bearer still work β
# we use whichever the server returns in the bound credentials.
session_id = str(uuid.uuid4())
pairing_code = _gen_pairing_code()
code_hash = _hash_pairing_code(pairing_code, session_id)
# Path-based URL on the dedicated auth subdomain (2026-05-20).
# auth.sibyllabs.org/<uuid> reads cleaner in the terminal than the old
# query-string form and aligns the wallet popup's "X wants you to sign in"
# header with the browser URL bar.
if ACTIVATE_BASE.rstrip("/").endswith(".sibyllabs.org") or ACTIVATE_BASE.rstrip("/").endswith("/auth"):
activate_url = f"{ACTIVATE_BASE.rstrip('/')}/{session_id}"
else:
# Legacy fallback: anyone with SIBYL_ACTIVATE_BASE pointing at the old
# /plugin/activate path keeps the query-string shape.
activate_url = f"{ACTIVATE_BASE}?session={session_id}"
# Pre-register the session + pairing code hash with the server.
# The code itself never leaves the user's machine until they type it
# into the browser.
#
# v0.3.5: capture pairing_ttl_seconds from the response and use it as
# the activation deadline. Server is the single source of truth β if
# the server-side TTL ever changes, the CLI adopts the new value
# automatically without a re-publish. INIT_TIMEOUT_FALLBACK_SEC only
# applies when the call fails entirely (network error) or the response
# is missing the field (schema drift).
pairing_ttl_seconds = None
try:
init_resp = http_request(
"POST",
"/api/plugin/session-init",
body={
"session": session_id,
"pairing_code_hash": code_hash,
"env": {
"os_family": _detect_os_family(),
"install_method": "cli",
"client_version": _client_version(),
},
},
timeout=10.0,
)
if isinstance(init_resp, dict):
v = init_resp.get("pairing_ttl_seconds")
if isinstance(v, (int, float)) and v > 0:
pairing_ttl_seconds = int(v)
except HttpError as e:
# Non-fatal: SIWE path doesn't need the pairing code. If session-init
# fails the user can still complete SIWE. Surface the warning.
print(yellow(f"Warning: session-init failed ({e.status}). Wallet path still works; email path may not."))
activation_window_sec = pairing_ttl_seconds if pairing_ttl_seconds else INIT_TIMEOUT_FALLBACK_SEC
print()
print(a.section_header("activation", subtitle="three paths Β· pick whichever fits your device"))
print()
print(a.kv("Session", short(session_id)))
formatted_code = pairing_code[:3] + " " + pairing_code[3:]
print(a.kv("Code", a.gradient_gold(formatted_code), value_color="accent")
+ " " + a.dim("(use this in the email panel)"))
print(a.kv("Opening", activate_url))
print()
print(a.dim(" desktop wallet Β· email + code Β· or send USDC from any mobile wallet"))
print(a.dim(" this terminal will pick up automatically when you bind."))
print()
try:
webbrowser.open(activate_url, new=2)
except Exception:
pass
# Poll /api/plugin/check
deadline = time.time() + activation_window_sec
last_status = ""
spinner = "β β β Ήβ Έβ Όβ ΄β ¦β §β β "
spin_i = 0
while time.time() < deadline:
try:
resp = http_request("GET", f"/api/plugin/check?session={urllib.parse.quote(session_id)}", timeout=10.0)
except HttpError as e:
if e.status in (404, 503, 0):
# Session not yet created server-side, or transient β keep polling
pass
else:
print(red(f"\nUnexpected error: {e.body}"))
return 2
resp = {"bound": False}
if resp.get("bound") and resp.get("credentials"):
raw_creds = resp["credentials"]
# CLI-15: never trust the server payload shape blindly. A non-dict
# `credentials` (string, list, null) would otherwise crash on .get
# or persist garbage. Treat it as "not yet bound" and keep polling.
if not isinstance(raw_creds, dict):
print(f"\r{' ' * 80}\r", end="")
print(red("\nServer returned malformed credentials. Re-run `sibyl init --force`."))
return 2
# SEC-1: prefer the server-issued bearer_token (post-fix) over
# echoing the URL pairing-session id. Servers running pre-SEC-1
# firmware echo `session_token` back as the bearer β we use
# whichever the server returns. The CLI's session_id (URL
# identifier) is the rendezvous key, not the persistent bearer.
bearer = raw_creds.get("bearer_token") or raw_creds.get("session_token")
if not bearer:
# Fallback: pre-SEC-1 server flow where neither field is
# echoed back β inject the pairing session id so subsequent
# /access and /check-write calls have something to send.
bearer = session_id
# Sanity check on echoed session_token (pre-SEC-1 flow only)
if raw_creds.get("session_token") and raw_creds["session_token"] != session_id \
and not raw_creds.get("bearer_token"):
print(red("\nSession token mismatch β refusing to write credentials."))
return 2
# CLI-15: build the persisted dict from an explicit allowlist of
# known fields, not the raw server blob. This keeps unexpected /
# hostile server-supplied keys out of credentials.json.
# Contract T (tenant resolution, Real #1): persist the server-issued
# tenant_id so mcp/hermes/langgraph all resolve the SAME tenant from
# this credentials.json. Without it the CLI dropped tenant_id on
# activation and every surface silently fell back to DEFAULT_TENANT.
_CRED_FIELDS = ("account_id", "tenant_id", "tier", "wallet", "email", "issued_at",
"bearer_token", "expires_at")
creds = {k: raw_creds[k] for k in _CRED_FIELDS if k in raw_creds}
creds["session_token"] = bearer
path = write_credentials_atomic(creds, cred_path)
print(f"\r{' ' * 80}\r", end="") # clear spinner line
print()
print(a.success_line("Activated."))
print()
print(a.kv("Account", short(creds.get("account_id"))))
print(a.kv("Tier", (creds.get("tier") or "free").upper(), value_color="accent"))
print(a.kv("Wallet", creds.get("wallet") or "β"))
print(a.kv("Email", creds.get("email") or "β"))
print(a.kv("Credentials", str(path)))
print()
print(a.section_header("wire it into your agent"))
print()
print(a.dim(" hermes:"))
print(a.dim(" sibyl-memory-hermes install-plugin"))
print(a.dim(" # then edit ~/.hermes/config.yaml:"))
print(a.dim(" # memory:"))
print(a.dim(" # provider: sibyl"))
print()
print(a.dim(" claude code / codex / cursor / continue (MCP):"))
print(a.dim(" pip install sibyl-memory-mcp"))
print()
print(a.dim(" python orchestration (langchain / llamaindex / custom):"))
print(a.dim(" from sibyl_memory_hermes import SibylMemoryProvider"))
print(a.dim(" provider = SibylMemoryProvider()"))
print()
return 0
# Spinner tick
spin_i = (spin_i + 1) % len(spinner)
remaining = int(deadline - time.time())
spin_glyph = a.color(spinner[spin_i], a.PULSE)
status = f"\r {spin_glyph} {a.dim('watching the network for your bind')} β¦ {a.dim(f'{remaining // 60}:{remaining % 60:02d} left')}"
if status != last_status:
sys.stdout.write(status)
sys.stdout.flush()
last_status = status
time.sleep(POLL_INTERVAL_SEC)
print()
print(a.err_line("Activation timed out."))
print(a.dim(" Re-run `sibyl init --force` to try again."))
print()
print(a.dim(" If your browser already showed 'Activation successful',"))
print(a.dim(" your bind landed server-side but didn't reach this terminal."))
print(a.dim(" Running `sibyl init --force` again will start a fresh handshake;"))
print(a.dim(" bind through the same browser to write credentials locally."))
return 1
# ---- `sibyl upgrade` ---------------------------------------------------
def cmd_upgrade(args: argparse.Namespace) -> int:
"""Upgrade flow. Read existing creds β open upgrade page β poll /access until tier flips."""
creds = read_credentials(Path(args.credentials).expanduser())
if not creds:
print(a.err_line("Not activated."))
print(a.dim(" Run `sibyl init` first."))
return 1
account_id = creds.get("account_id")
session_token = creds.get("session_token")
current_tier = (creds.get("tier") or "free").lower()
if not account_id or not session_token:
print(a.err_line("credentials.json is missing account_id or session_token."))
print(a.dim(" Re-run `sibyl init`."))
return 1
upgrade_url = f"{UPGRADE_BASE}?session={session_token}"
print()
print(a.section_header("upgrade", subtitle="lift the 2 MB free-tier cap"))
print()
print(a.kv("Account", short(account_id)))
print(a.kv("Current tier", current_tier.upper(), value_color="accent"))
# F3 (red-team 2026-06-17): never print the bearer to stdout (terminal
# scrollback / tmux / CI logs / screen-shares) β restores the invariant
# stated at the top of this file. Show the bare base URL only; the token
# still rides the opened browser URL (moving that handoff to a one-time
# server-issued exchange code is the tracked server-side follow-up).
print(a.kv("Opening", UPGRADE_BASE))
print()
print(a.dim(" two paths in the browser:"))
print(a.dim(" 1. stake $SIBYL on Base (free unlimited if you qualify)"))
print(a.dim(" 2. subscribe in USDC (monthly / quarterly / annual)"))
print()
try:
webbrowser.open(upgrade_url, new=2)
except Exception:
pass
# Poll /api/plugin/access until tier changes
deadline = time.time() + UPGRADE_TIMEOUT_SEC
last_status = ""
spinner = "β β β Ήβ Έβ Όβ ΄β ¦β §β β "
spin_i = 0
while time.time() < deadline:
try:
resp = http_request(
"POST",
"/api/plugin/access",
body={"account_id": account_id, "session_token": session_token},
timeout=10.0,
)
except HttpError as e:
if e.status == 401:
print(red("\nSession expired. Re-run `sibyl init`."))
return 1
# Transient β keep polling
resp = {}
new_tier = (resp.get("tier") or current_tier).lower()
source = resp.get("source")
if new_tier != current_tier and source in ("subscription", "staker"):
# Tier changed. Refresh credentials.
creds["tier"] = new_tier
if resp.get("staker") and resp["staker"].get("wallet"):
creds["wallet"] = resp["staker"]["wallet"]
write_credentials_atomic(creds, Path(args.credentials).expanduser())
invalidate_tier_cache()
print(f"\r{' ' * 80}\r", end="")
print()
print(a.success_line(f"Upgraded to {new_tier.upper()} via {source}."))
print()
print(a.kv("Source", source))
if resp.get("expires_at"):
print(a.kv("Expires", resp["expires_at"]))
if resp.get("cap_bytes") is None:
print(a.kv("Storage cap", "unlimited", value_color="ok"))
else:
print(a.kv("Storage cap", f"{_fmt_cap_bytes(resp.get('cap_bytes'))} bytes"))
if resp.get("staker"):
s = resp["staker"]
print(a.kv("Wallet", s.get("wallet", "β")))
print(a.kv("$SIBYL held", str(s.get("total_sibyl", "β"))))
print()
print(a.dim(" local tier cache cleared. your next write will sync the new tier."))
return 0
spin_i = (spin_i + 1) % len(spinner)
remaining = int(deadline - time.time())
spin_glyph = a.color(spinner[spin_i], a.PULSE)
tier_glyph = a.color(current_tier.upper(), a.ACCENT)
status = f"\r {spin_glyph} {a.dim('waiting for browser upgrade')} Β· current: {tier_glyph} {a.dim(f'{remaining // 60}:{remaining % 60:02d} left')}"
if status != last_status:
sys.stdout.write(status)
sys.stdout.flush()
last_status = status
time.sleep(POLL_INTERVAL_SEC)
print()
print(a.err_line("Upgrade timed out. Tier unchanged."))
print(a.dim(" Re-run `sibyl upgrade` to retry."))
return 1
# ---- `sibyl status` ----------------------------------------------------
def _discover_stores(primary_db: Path) -> list[dict[str, Any]]:
"""Enumerate every memory.db an agent on this machine might resolve.
Beta reports (VRTX 2026-06-11) showed split-brain storage: the SDK / CLI /
MCP default (``~/.sibyl-memory/memory.db``), the Hermes adapter
(``$HERMES_HOME/sibyl/memory.db``), per-profile DBs
(``$HERMES_HOME/sibyl/profiles/<p>/memory.db``), and an MCP
``SIBYL_MEMORY_DB`` override can each hold a disjoint set of memories, so a
user switching entry points sees memory "vanish". This surfaces all of
them in one place. Read-only: it never creates or moves anything (path
unification is a separate, migration-gated change).
Returns one dict per DISTINCT existing store, resolved + deduped:
``{"label", "path", "size"}``.
"""
candidates: list[tuple[str, Path]] = [("default (SDK/CLI/MCP)", primary_db)]
hermes_home_env = os.environ.get("HERMES_HOME")
hermes_home = Path(hermes_home_env).expanduser() if hermes_home_env else (Path.home() / ".hermes")
candidates.append(("hermes adapter", hermes_home / "sibyl" / "memory.db"))
profiles_dir = hermes_home / "sibyl" / "profiles"
if profiles_dir.is_dir():
# #15 hygiene: iterdir() raises PermissionError on a restricted
# profiles directory (e.g. a 0700 dir owned by another user). Skip the
# whole profiles sweep gracefully rather than crashing `sibyl status`.
try:
profiles = sorted(profiles_dir.iterdir())
except (PermissionError, OSError):
profiles = []
for prof in profiles:
db = prof / "memory.db"
if db.exists():
candidates.append((f"hermes profile Β· {prof.name}", db))
mcp_override = os.environ.get("SIBYL_MEMORY_DB")
if mcp_override:
candidates.append(("MCP SIBYL_MEMORY_DB", Path(mcp_override).expanduser()))
seen: set[str] = set()
stores: list[dict[str, Any]] = []
for label, path in candidates:
try:
resolved = str(path.resolve())
except OSError:
resolved = str(path)
if resolved in seen or not path.exists():
continue
seen.add(resolved)
try:
size = path.stat().st_size
except OSError:
size = 0
stores.append({"label": label, "path": str(path), "size": size})
return stores
def cmd_status(args: argparse.Namespace) -> int:
"""Show local + server-side state without modifying anything.
LIGHT treatment: utilitarian dashboard. No banner, no section header,
no chrome. Eyebrow labels + kv rows + β status drift surfaces. Same
convention as `git status`, `ls -la`, `btop` panel bodies."""
cred_path = Path(args.credentials).expanduser()
creds = read_credentials(cred_path)
print()
if not creds:
print(a.warn_line("Not activated."))
print(a.dim(" Run `sibyl init`."))
return 0
# Local view
print(a.eyebrow("local"))
print(a.kv("Credentials", str(cred_path)))
print(a.kv("Account", short(creds.get("account_id"))))
print(a.kv("Tier", (creds.get("tier") or "free").upper(), value_color="accent"))
print(a.kv("Wallet", creds.get("wallet") or "β"))
print(a.kv("Email", creds.get("email") or "β"))
print(a.kv("Issued", creds.get("issued_at") or "β"))
db_path = Path(args.db).expanduser()
if db_path.exists():
# CLI-3 / D3: a path that exists but is not a SQLite DB is labeled
# explicitly instead of being reported as a normal memory store.
if not is_sqlite_db(db_path):
# Not a DB: report the raw file size, since the logical SQLite
# measure does not apply to an arbitrary file.
size = db_path.stat().st_size
print(a.kv("DB path", str(db_path)))
print(a.kv("DB size", f"{size:,} bytes (not a SQLite database)", value_color="err"))
else:
# B001 (audit #13): report the same WAL-inclusive logical footprint
# the cap gate enforces (sibyl_memory_client.storage.db_size_bytes),
# not the raw memory.db st_size. The raw file under-reports during a
# write burst (committed pages still in memory.db-wal), so the
# displayed size/percentage would otherwise disagree with the gate.
from sibyl_memory_client.storage import db_size_bytes
size = db_size_bytes(db_path)
pct = size / 2_097_152 * 100
size_label = f"{size:,} bytes ({size / (1024 * 1024):.2f} MB Β· {pct:.1f}% of free cap)"
size_color = "warn" if pct > 80 else "soft"
print(a.kv("DB path", str(db_path)))
print(a.kv("DB size", size_label, value_color=size_color))
else:
print(a.kv("DB path", f"{db_path} (not created)"))
# All resolvable stores on this machine (split-brain visibility floor,
# VRTX beta report 2026-06-11). Read-only: lists what exists, moves
# nothing. A divergence warning fires when more than one store holds data,
# because that is exactly when an agent "loses" memory by switching the
# entry point it reads from.
stores = _discover_stores(db_path)
if len(stores) > 1:
print()
print(a.eyebrow("memory stores"))
for s in stores:
mb = s["size"] / (1024 * 1024)
print(a.kv(s["label"], f"{s['path']} ({s['size']:,} bytes Β· {mb:.2f} MB)"))
with_data = [s for s in stores if s["size"] > 0]
if len(with_data) > 1:
print()
print(a.warn_line("Multiple memory stores hold data on this machine."))
print(a.dim(" Memory is NOT shared across these paths. An agent reads only the store"))
print(a.dim(" for its entry point (SDK/CLI vs Hermes vs profile vs MCP), so memory can"))
print(a.dim(" look 'missing' when you switch. Point every entry point at one path via"))
print(a.dim(" --db / SIBYL_MEMORY_DB, or back up and consolidate before relying on recall."))
tier_cache = Path(args.tier_cache).expanduser()
if tier_cache.exists():
# CLI-4: a corrupt tier_cache.json must not crash `sibyl status` β
# same crash class as D1, separate call site. Degrade to empty dict.
try:
cache = json.loads(tier_cache.read_text(encoding="utf-8"))
except (ValueError, OSError):
cache = {}
if not isinstance(cache, dict):
cache = {}
# checked_at is written by _capcheck.py as epoch seconds (float), but
# older caches / future formats may carry an ISO string. Render both;
# never index a float (TypeError on every `sibyl status` run with a
# populated tier cache; Discord report 2026-06-10).
checked = cache.get("checked_at")
if isinstance(checked, (int, float)) and not isinstance(checked, bool):
checked = time.strftime("%Y-%m-%dT%H:%M:%S", time.gmtime(checked))
checked = str(checked)[:19] if checked else "?"
print(a.kv("Tier cache", f"{cache.get('tier','?')} (checked {checked})"))
else:
print(a.kv("Tier cache", "β"))
# Server view (only if account_id + session_token are present)
if creds.get("account_id") and creds.get("session_token"):
print()
print(a.eyebrow("server"))
try:
resp = http_request(
"POST",
"/api/plugin/access",
body={"account_id": creds["account_id"], "session_token": creds["session_token"]},
timeout=10.0,
)
print(a.kv("Tier", (resp.get("tier") or "free").upper(), value_color="accent"))
print(a.kv("Source", resp.get("source") or "β"))
print(a.kv("Cap bytes", _fmt_cap_bytes(resp.get("cap_bytes"))))
if resp.get("expires_at"):
print(a.kv("Expires", resp["expires_at"]))
if resp.get("staker"):
s = resp["staker"]
print(a.kv("$SIBYL held", str(s.get("total_sibyl", "β"))))
print(a.kv("Threshold", str(s.get("threshold_sibyl", "β"))))
print(a.kv("Qualified", "yes" if s.get("qualified") else "no",
value_color="ok" if s.get("qualified") else "soft"))
# Detect server/local drift
srv_tier = (resp.get("tier") or "free").lower()
loc_tier = (creds.get("tier") or "free").lower()
if srv_tier != loc_tier:
print()
print(a.warn_line(f"Local tier ({loc_tier}) differs from server tier ({srv_tier})."))
print(a.dim(" Run `sibyl upgrade` to refresh, or `sibyl init --force` to re-activate."))
except HttpError as e:
print(a.kv("Tier", f"server error: {e.status}", value_color="err"))
print()
return 0
# ---- `sibyl dashboard` (placeholder, today routes to status) -----------
def cmd_dashboard(args: argparse.Namespace) -> int:
"""Open the web account dashboard. In v0.1.0, the dashboard at
account.sibyllabs.org is not yet live (queued post-V1-ship per the
operator design memo). Until then, `sibyl dashboard` delegates to
`sibyl status` so the command surface exists from day one and users
who muscle-memory it get a real result.
When account.sibyllabs.org ships, this will flip to
`webbrowser.open(...)` with no UX disruption β same command, real
web dashboard."""
DASHBOARD_BASE = os.environ.get("SIBYL_DASHBOARD_BASE")
if DASHBOARD_BASE:
# If env var is set, open the web dashboard with the session token.
creds = read_credentials(Path(args.credentials).expanduser())
if creds and creds.get("session_token"):
url = f"{DASHBOARD_BASE}?session={creds['session_token']}"
print()
print(bold("Sibyl Memory Plugin Β· dashboard"))
# F3: don't print the bearer-bearing URL to stdout; show base only.
print(f" {dim('Opening:')} {DASHBOARD_BASE}")
print()
try:
webbrowser.open(url, new=2)
except Exception:
pass
return 0
# Fall through: account.sibyllabs.org isn't live yet, run status instead.
return cmd_status(args)
# ---- `sibyl whoami` ----------------------------------------------------
def _mask_email(e: str | None) -> str:
if not e or "@" not in e:
return "β"
user, _, domain = e.partition("@")
if "." not in domain:
return f"{user[0]}***@{domain[0]}***"
name, _, tld = domain.rpartition(".")
return f"{user[0]}***@{name[0]}***.{tld}"
def _mask_wallet(w: str | None) -> str:
if not w or not w.startswith("0x") or len(w) < 12:
return w or "β"
return f"{w[:6]}β¦{w[-4:]}"
def cmd_whoami(args: argparse.Namespace) -> int:
"""One-line account summary. Shows account_id + tier + linked email/wallet + this device.
LIGHT treatment: 4-line glance. No banner, no section header. Same shape
as `whoami` on unix, `gh auth status`, `aws sts get-caller-identity`."""
creds = read_credentials(Path(args.credentials).expanduser())
if not creds:
print(a.warn_line("Not activated."))
print(a.dim(" Run `sibyl init`."))
return 1
full = bool(getattr(args, "full", False))
acct = creds.get("account_id") or ""
tier = (creds.get("tier") or "free").upper()
email = creds.get("email") if full else _mask_email(creds.get("email"))
wallet = creds.get("wallet") if full else _mask_wallet(creds.get("wallet"))
print()
print(f" {a.color('account', a.INK_FAINT)} {a.bold(short(acct))} {a.dim(a.GLYPH_DOT)} {a.gradient_gold(tier)}")
print(f" {a.color('wallet ', a.INK_FAINT)} {a.color(wallet or 'β', a.INK)}")
print(f" {a.color('email ', a.INK_FAINT)} {a.color(email or 'β', a.INK)}")
os_label = _detect_os_family() or "unknown"
device_line = f"sibyl-memory-cli/{_client_version()} {os_label}"
print(f" {a.color('device ', a.INK_FAINT)} {a.dim(device_line)}")
print()
return 0
# ---- `sibyl devices` ---------------------------------------------------
def cmd_devices(args: argparse.Namespace) -> int:
"""List active bearer tokens (devices) for the account. Optional: revoke by index."""
creds = read_credentials(Path(args.credentials).expanduser())
if not creds:
print(a.err_line("Not activated."))
print(a.dim(" Run `sibyl init`."))
return 1
account_id = creds.get("account_id")
session_token = creds.get("session_token")
if not account_id or not session_token:
print(a.err_line("credentials.json missing account_id or session_token."))
print(a.dim(" Run `sibyl init`."))
return 1
sub = getattr(args, "sub", None)
# `sibyl devices revoke <index>` path
if sub == "revoke":
idx = getattr(args, "index", None)
if idx is None:
print(red("usage: sibyl devices revoke <index>"))
return 1
# CLI-5: reject negative indexes. Python's negative indexing means
# `revoke -1` would silently target the LAST device β a footgun that
# could revoke the wrong (or your own) device. Require an explicit
# non-negative index from `sibyl devices` output.
if idx < 0:
print(red(f"invalid index {idx}. Use a non-negative index from `sibyl devices`."))
return 1
# List first to map index β bearer_id
try:
resp = http_request(
"GET",
f"/api/plugin/devices?account_id={urllib.parse.quote(account_id)}",
headers={"Authorization": f"Bearer {session_token}"},
timeout=10.0,
)
except HttpError as e:
print(red(f"server error: {e.status} {e.body}"))
return 2
devices = resp.get("devices", [])
try:
target = devices[idx]
except (IndexError, TypeError):
print(red(f"no device at index {idx}. Run `sibyl devices` to see indexes."))
return 1
if not isinstance(target, dict):
print(red(f"malformed device record at index {idx}. Run `sibyl devices`."))
return 2
if target.get("is_this_device"):
print(red("refusing to revoke your own device β that would lock you out. Run `sibyl logout` instead, then `sibyl init` on a fresh activation."))
return 1
# CLI-5: bail cleanly if the server payload lacks bearer_id instead of
# raising KeyError on hostile/malformed data.
bearer_id = target.get("bearer_id")
if not bearer_id:
print(red(f"device at index {idx} has no bearer_id. Run `sibyl devices` to refresh."))
return 2
try:
revoke_resp = http_request(
"POST",
"/api/plugin/devices",
body={"bearer_id": bearer_id},
headers={"Authorization": f"Bearer {session_token}"},
timeout=10.0,
)
except HttpError as e:
print(red(f"revoke failed: {e.status} {e.body}"))
return 2
print(green(f"β Revoked device {target.get('device_label') or bearer_id}"))
return 0 if revoke_resp.get("revoked") else 1
# Default: list devices
try:
resp = http_request(
"GET",
f"/api/plugin/devices?account_id={urllib.parse.quote(account_id)}",
headers={"Authorization": f"Bearer {session_token}"},
timeout=10.0,
)
except HttpError as e:
if e.status == 401:
print(a.err_line("Session expired."))
print(a.dim(" Re-run `sibyl init`."))
else:
print(a.err_line(f"server error: {e.status} {e.body}"))
return 2
devices = resp.get("devices", [])
# LIGHT treatment: table-like dashboard. Eyebrow line with count + the rows. No banner.
print()
print(f" {a.eyebrow('devices')} {a.dim(f'Β· {len(devices)} active')}")
print()
if not devices:
print(a.dim(" no active devices"))
print()
return 0
for i, d in enumerate(devices):
is_this = d.get("is_this_device")
marker = a.ok("βΆ") if is_this else " "
label = d.get("device_label") or "(unlabeled)"
installed = d.get("install_method") or "β"
last_seen = d.get("last_seen_at", "")[:19].replace("T", " ")
idx_chip = a.chip(str(i), palette="jade" if is_this else "mute")
label_color = a.gradient_gold(label) if is_this else a.color(label, a.INK)
meta = f"{a.dim(installed)} {a.dim(a.GLYPH_DOT)} {a.dim('last seen ' + last_seen)}"
note = a.color("(this device)", a.PULSE) if is_this else a.dim(f"revoke: sibyl devices revoke {i}")
print(f" {marker} {idx_chip} {label_color} {meta} {note}")
print()
return 0
# ---- `sibyl logout` ----------------------------------------------------
# Real #4 (audit): the same offline caveat wherever a logout revoke can't be
# confirmed β mirrors the `sibyl devices revoke` remediation path.
_LOGOUT_REVOKE_CAVEAT = (
"remote session may still be active; run `sibyl devices revoke` from another device"
)
def _logout_revoke_bearer(creds: dict) -> str | None:
"""Best-effort revoke THIS device's server bearer before local logout.
Real #4 (audit): `sibyl logout` used to unlink local credentials only, so
the bearer β which has no server-side expiry β stayed valid forever after
logout. This revokes it first, reusing the EXACT endpoint + auth shape of
`sibyl devices revoke` (no new endpoint invented):
GET /api/plugin/devices?account_id=... (Authorization: Bearer <token>)
POST /api/plugin/devices {"bearer_id": ...} (same Bearer auth)
credentials.json stores only the bearer TOKEN, not its server-side
bearer_id, so we list devices to find THIS one (``is_this_device``) and
revoke it by id β identical to the interactive revoke flow.
Returns None on a confirmed revoke (or when there is nothing to revoke);
otherwise a caveat string to surface. Network failure is swallowed but
reported (never crashes logout).
"""
account_id = creds.get("account_id")
session_token = creds.get("session_token")
if not account_id or not session_token:
# Pre-activation / malformed creds: nothing server-side to revoke.
return None
auth = {"Authorization": f"Bearer {session_token}"}
try:
resp = http_request(
"GET",
f"/api/plugin/devices?account_id={urllib.parse.quote(account_id)}",
headers=auth,
timeout=10.0,
)
devices = resp.get("devices", []) if isinstance(resp, dict) else []
this = next(
(d for d in devices if isinstance(d, dict) and d.get("is_this_device")),
None,
)
bearer_id = this.get("bearer_id") if this else None
if not bearer_id:
# Couldn't identify this device's server record β can't confirm.
return _LOGOUT_REVOKE_CAVEAT
revoke_resp = http_request(
"POST",
"/api/plugin/devices",
body={"bearer_id": bearer_id},
headers=auth,
timeout=10.0,
)
if isinstance(revoke_resp, dict) and revoke_resp.get("revoked"):
return None
return _LOGOUT_REVOKE_CAVEAT
except Exception:
# Best-effort: swallow ANY network/HTTP failure, but report it so the
# user knows the remote bearer may still be live.
return _LOGOUT_REVOKE_CAVEAT
def cmd_logout(args: argparse.Namespace) -> int:
"""Delete credentials.json + tier_cache.json. memory.db stays β that's your data."""
cred_path = Path(args.credentials).expanduser()
tier_cache = Path(args.tier_cache).expanduser()
# Real #4: revoke THIS device's server bearer BEFORE unlinking local creds
# (once credentials.json is gone we no longer have the token to authorize
# the revoke). Best-effort; a failure only produces a printed caveat.
revoke_caveat = None
creds = read_credentials(cred_path)
if creds:
revoke_caveat = _logout_revoke_bearer(creds)
deleted = []
if cred_path.exists():
cred_path.unlink()
deleted.append(str(cred_path))
if tier_cache.exists():
tier_cache.unlink()
deleted.append(str(tier_cache))
# LIGHT treatment: quick confirmation. No banner, no section header.
print()
if not deleted:
print(a.warn_line("Nothing to remove."))
print(a.dim(" Already logged out."))
else:
print(a.success_line("Logged out."))
for path in deleted:
print(f" {a.dim('removed')} {a.color(path, a.INK)}")
print()
print(a.dim(" memory.db untouched. run `sibyl init` to activate a fresh account."))
if revoke_caveat:
print(a.warn_line(revoke_caveat))
print()
return 0
# ---- `sibyl health` ----------------------------------------------------
def cmd_health(args: argparse.Namespace) -> int:
"""SibylMemoryProvider.health() β minimal self-check."""
try:
from sibyl_memory_hermes import SibylMemoryProvider
except ImportError:
print(a.err_line("sibyl-memory-hermes not installed."))
print(a.dim(" pip install sibyl-memory-hermes"))
return 1
# LIGHT treatment: verdict + details. No banner, no section header.
# Pattern: `pg_isready` / `redis-cli ping` / `gh auth status`.
print()
# CLI-6: expanduser the db path (a leading ~ was passed through literally),
# and wrap provider construction + health() so a bad DB / provider error
# prints a clean line instead of a traceback.
db_path = Path(args.db).expanduser()
try:
provider = SibylMemoryProvider(db_path=str(db_path))
h = provider.health()
except Exception as e:
print(a.err_line(f"Health check failed: {type(e).__name__}: {e}"))
print()
return 1
if not isinstance(h, dict):
print(a.err_line("Health check returned an unexpected result."))
print()
return 1
ok_state = bool(h.get("ok"))
if ok_state:
print(a.success_line("All green."))
else:
print(a.err_line("Health check reports issues."))
print()
for k, v in h.items():
if k == "ok":
continue
val = str(v)
print(a.kv(k, val, value_color="ok" if v is True else ("soft" if v else "warn")))
print()
return 0 if ok_state else 1
# ---- `sibyl update` ----------------------------------------------------
# Three user-facing packages we offer to upgrade. `mcp` is opt-in and not
# bundled by default β skip it here so we don't tell users to "update"
# something they may not have installed. Add it back when an `--include-mcp`
# flag is shipped.
UPDATE_PACKAGES = ("sibyl-memory-cli", "sibyl-memory-hermes", "sibyl-memory-client")
def _installed_version(pkg: str) -> str | None:
"""Return the locally-installed version of a package, or None if not installed."""
try:
from importlib.metadata import PackageNotFoundError, version as _v
try:
return _v(pkg)
except PackageNotFoundError:
return None
except Exception:
return None
def _pypi_latest(pkg: str, timeout: float = 4.0) -> str | None:
"""Hit PyPI's JSON endpoint for the latest published version. Best-effort."""
url = f"https://pypi.org/pypi/{pkg}/json"
try:
req = urllib.request.Request(url, headers={"User-Agent": f"sibyl-memory-cli/{_client_version()}"})
with urllib.request.urlopen(req, timeout=timeout) as r:
data = json.loads(r.read().decode("utf-8"))
return (data.get("info") or {}).get("version")
except Exception:
return None
def _ver_tuple(v: str) -> tuple:
"""Lenient version tuple for comparison. Splits on '.', tolerates non-numeric tails."""
out = []
for part in (v or "").split("."):
digits = ""
for ch in part:
if ch.isdigit():
digits += ch
else:
break
out.append(int(digits) if digits else 0)
return tuple(out)
def _ver_lt(installed: str, latest: str) -> bool:
"""True if `installed` is strictly older than `latest`.
CLI-13: prefer packaging.version.parse for PEP 440 correctness (rc/dev/post
tags handled, 1.2 == 1.2.0). If packaging is unavailable (stdlib-only
environments), fall back to a length-normalized numeric-tuple compare so
1.2 vs 1.2.0 no longer mis-orders (the old raw-tuple compare made (1,2) <
(1,2,0), reporting a spurious update)."""
try:
from packaging.version import InvalidVersion, parse as _parse
try:
return _parse(installed) < _parse(latest)
except InvalidVersion:
pass # fall through to tuple compare on unparseable input
except ImportError:
pass
a_t, b_t = _ver_tuple(installed), _ver_tuple(latest)
width = max(len(a_t), len(b_t))
a_t = a_t + (0,) * (width - len(a_t))
b_t = b_t + (0,) * (width - len(b_t))
return a_t < b_t
def _detect_install_method() -> str:
"""Best-guess of how the CLI was installed β pipx / venv / system-pip / pep668-blocked."""
exe = sys.executable
if "/pipx/" in exe or "/.local/pipx/" in exe:
return "pipx"
if exe and ("venv" in exe.lower() or "virtualenv" in exe.lower() or os.environ.get("VIRTUAL_ENV")):
return "venv"
# Look for PEP 668 marker file
for parent in Path(exe).resolve().parents:
marker = parent / "lib" / "EXTERNALLY-MANAGED"
if marker.exists():
return "pep668"
marker2 = parent / "EXTERNALLY-MANAGED"
if marker2.exists():
return "pep668"
if str(parent) in ("/", "/home", "/usr"):
break
return "system"
def cmd_update(args: argparse.Namespace) -> int:
"""Check installed package versions against PyPI, optionally apply upgrade."""
rows = []
any_outdated = False
for pkg in UPDATE_PACKAGES:
installed = _installed_version(pkg)
latest = _pypi_latest(pkg)
outdated = False
if installed and latest:
outdated = _ver_lt(installed, latest)
rows.append({"pkg": pkg, "installed": installed, "latest": latest, "outdated": outdated})
if outdated:
any_outdated = True
if args.json:
print(json.dumps({"packages": rows, "any_outdated": any_outdated}, indent=2))
return 0 if not any_outdated else 2
# ASCII output β keep it small and readable, follow `sibyl status` style.
print()
if any_outdated:
print(a.err_line("Updates available."))
else:
# Distinguish "all current" from "could not reach PyPI"
any_unreachable = any(r["latest"] is None for r in rows)
if any_unreachable:
print(a.dim("Could not reach PyPI for one or more packages β showing what we know."))
else:
print(a.success_line("All packages current."))
print()
name_w = max(len(r["pkg"]) for r in rows)
for r in rows:
installed = r["installed"] or "(not installed)"
latest = r["latest"] or "(unreachable)"
if r["outdated"]:
line = f" {yellow(r['pkg'].ljust(name_w))} {installed} β {green(latest)}"
elif r["installed"] is None:
line = f" {a.dim(r['pkg'].ljust(name_w))} {a.dim(installed)}"
else:
line = f" {r['pkg'].ljust(name_w)} {a.dim(installed)}"
print(line)
print()
if not any_outdated:
return 0
pip_cmd_pkgs = " ".join(r["pkg"] for r in rows if r["outdated"])
method = _detect_install_method()
if args.apply:
# Best-effort in-process pip invocation
import subprocess
pip_args = [sys.executable, "-m", "pip", "install", "-U", *pip_cmd_pkgs.split()]
if method == "pep668":
pip_args.append("--break-system-packages")
if method == "pipx":
# pipx is a separate tool; we can't drive it via `pip install`.
print(a.err_line("Detected pipx install. Run instead:"))
print(f" pipx upgrade {' '.join(r['pkg'] for r in rows if r['outdated'])}")
return 2
print(a.dim("Running: ") + " ".join(pip_args))
try:
rc = subprocess.call(pip_args)
except FileNotFoundError:
print(a.err_line("pip not found at " + sys.executable + " -m pip"))
return 2
if rc == 0:
print()
print(a.success_line("Upgrade complete. Re-run `sibyl update` to confirm."))
return rc
# Default: print the command, do not execute
print(a.dim("To upgrade, run:"))
if method == "pipx":
print(f" pipx upgrade {pip_cmd_pkgs}")
elif method == "pep668":
print(f" pip install --break-system-packages -U {pip_cmd_pkgs}")
print()
print(a.dim(" (Your Python flags itself as externally-managed under PEP 668.)"))
print(a.dim(" (Cleanest: install inside a venv. See https://beta.sibyllabs.org for the recommended path.)"))
else:
print(f" pip install -U {pip_cmd_pkgs}")
print()
print(a.dim("Or let sibyl run it:") + " sibyl update --apply")
print()
return 2 # exit 2 signals "outdated" without being a hard error
# ---- Guided migration (sibyl migrate) ----------------------------------
def _migrate_io():
"""Interactive IO for the guided flow: prints narration live and reads real
stdin for pauses/confirms. Subclasses the testable GuidedIO seam in migrate.py
(whose .say() only buffers, for non-interactive tests)."""
from .migrate import GuidedIO
class _PrintingIO(GuidedIO):
def say(self, s: str = "") -> None:
super().say(s)
print(s)
return _PrintingIO()
def cmd_migrate(args: argparse.Namespace) -> int:
"""`sibyl migrate` β guided onboarding. Backs up existing memory/agent files
FIRST, wires Sibyl into every detected harness, hands the semantic extraction
to the user's own agent (it holds the memory tools; Sibyl Labs never sees the
files), verifies what landed, then optionally trims the originals β only on an
explicit confirm and only because a verified backup exists."""
from . import migrate as M
home = Path.home()
cwd = Path.cwd()
db_path = Path(args.db).expanduser()
backup_parent = Path(args.backup_dir).expanduser() if getattr(args, "backup_dir", None) else home
print()
print(bold("Sibyl Memory β guided migration"))
print(dim("Back up existing memory, populate Sibyl Memory, optionally slim the originals."))
print()
print(yellow("Your files are copied to a timestamped backup FIRST and are never modified"))
print(yellow("except by an explicit, confirmed trim at the very end. You run the extraction"))
print(yellow("in your own agent β Sibyl Labs never sees your files or memory."))
print(dim("No warranty: keep your backup. Sibyl Labs is not responsible for data loss."))
print()
files = M.scan_memory_files(home, cwd)
if not files:
print(yellow("No memory/agent files found in your home or current project."))
print(dim("Looked for CLAUDE.md, AGENTS.md, .codex/config.toml, .hermes/*, and similar."))
print(dim("If your files live elsewhere, run this from that project directory."))
return 0
print(dim("Will back up (originals untouched):"))
for f in files:
kind = "dir " if f.is_dir else "file"
print(f" {kind} {f.rel} {dim(f'({f.size} bytes)')}")
print()
print(dim("After Sibyl is wired, if your agent was already open, restart it (or"))
print(dim("reconnect the sibyl-memory MCP) before running the extraction prompt."))
print()
if not args.yes:
try:
ans = input("Proceed? [Y/n]: ").strip().lower()
except EOFError:
ans = ""
if ans.startswith("n"):
print(dim("Aborted. Nothing was changed."))
return 0
print()
io = _migrate_io()
report = M.run_guided_setup(
home=home, cwd=cwd, db_path=db_path, backup_parent=backup_parent,
io=io, debloat=not args.no_debloat, force=getattr(args, "force", False),
)
ph = report.get("phases", {})
print()
print(bold("Summary"))
bk = ph.get("backup", {})
if bk:
print(f" {green('backup')} {bk.get('files', 0)} files")
print(f" {dim('location')} {bk.get('dir', '')}")
wire = ph.get("wire", {})
if wire:
wired = ", ".join(f"{n} ({s})" for n, s in wire.items())
print(f" {green('wired')} {wired}")
v = ph.get("verify", {})
if v:
cats = ", ".join(f"{k}:{n}" for k, n in (v.get("by_category") or {}).items())
print(f" {green('extracted')} {v.get('new_total', 0)} new entries" + (f" {dim(cats)}" if cats else ""))
db = ph.get("debloat")
if db and db.get("written"):
saved = max(0, db.get("before", 0) - db.get("after", 0))
print(f" {green('trimmed')} CLAUDE.md {dim(f'(-{saved} bytes; full copy in backup)')}")
if not report.get("ok"):
print()
print(yellow("Migration did not complete. Your originals and backup are intact."))
return 1
print()
print(green("Done. Your memory now lives in Sibyl and is recalled on demand."))
if bk:
print(dim(f"Backup retained at {bk.get('dir','')} β delete it once you've confirmed everything."))
return 0
# ---- Dispatch ----------------------------------------------------------
def build_parser() -> argparse.ArgumentParser:
p = argparse.ArgumentParser(
prog="sibyl",
description="Command-line interface for the Sibyl Memory Plugin.",
)
p.add_argument("--credentials", default=str(DEFAULT_CRED_PATH),
help="Path to credentials.json (default: ~/.sibyl-memory/credentials.json)")
p.add_argument("--db", default=str(DEFAULT_DB_PATH),
help="Path to memory.db (default: ~/.sibyl-memory/memory.db)")
p.add_argument("--tier-cache", default=str(DEFAULT_TIER_CACHE_PATH),
help="Path to tier_cache.json (default: ~/.sibyl-memory/tier_cache.json)")
sub = p.add_subparsers(dest="cmd", required=True)
p_init = sub.add_parser("init", help="Activate the plugin in your browser")
p_init.add_argument("--force", action="store_true", help="Re-activate even if credentials.json exists")
p_init.set_defaults(func=cmd_init)
p_up = sub.add_parser("upgrade", help="Open the upgrade flow (stake or subscribe)")
p_up.set_defaults(func=cmd_upgrade)
p_st = sub.add_parser("status", help="Show local + server tier / DB stats")
p_st.set_defaults(func=cmd_status)
p_who = sub.add_parser("whoami", help="One-line account summary (masked by default)")
p_who.add_argument("--full", action="store_true", help="Show full email + wallet (no masking)")
p_who.set_defaults(func=cmd_whoami)
p_dev = sub.add_parser("devices", help="List devices (active bearer tokens) for the account")
dev_sub = p_dev.add_subparsers(dest="sub")
p_rev = dev_sub.add_parser("revoke", help="Revoke a device by index (run `sibyl devices` for indexes)")
p_rev.add_argument("index", type=int, help="Index from `sibyl devices` output")
p_dev.set_defaults(func=cmd_devices)
p_rev.set_defaults(func=cmd_devices)
p_dash = sub.add_parser("dashboard", help="Open the account dashboard (delegates to status until account.sibyllabs.org ships)")
p_dash.set_defaults(func=cmd_dashboard)
p_lo = sub.add_parser("logout", help="Remove local credentials (memory.db stays)")
p_lo.set_defaults(func=cmd_logout)
p_h = sub.add_parser("health", help="Run the provider self-check")
p_h.set_defaults(func=cmd_health)
p_mem = sub.add_parser("memory", help="Read-only inspection of your memory store (list / search / recall)")
mem_sub = p_mem.add_subparsers(dest="mem_cmd")
p_ml = mem_sub.add_parser("list", help="List entities (optionally filtered by category)")
p_ml.add_argument("category", nargs="?", default=None, help="Optional category to filter by")
p_ml.add_argument("--limit", type=int, default=50, help="Max rows (default 50)")
p_ml.set_defaults(func=cmd_memory)
p_ms = mem_sub.add_parser("search", help="Full-text search across entities + state + reference + journal")
p_ms.add_argument("query", help="Search query (matches stored text, not meaning)")
p_ms.add_argument("--limit", type=int, default=20, help="Max hits (default 20)")
p_ms.set_defaults(func=cmd_memory)
p_mr = mem_sub.add_parser("recall", help="Recall one entity by category + name")
p_mr.add_argument("category", help="Entity category")
p_mr.add_argument("name", help="Entity name")
p_mr.set_defaults(func=cmd_memory)
p_mem.set_defaults(func=cmd_memory)
p_update = sub.add_parser(
"update",
help="Check for newer sibyl-memory-* releases on PyPI (use --apply to upgrade)",
)
p_update.add_argument("--apply", action="store_true", help="Run pip install -U for the outdated packages")
p_update.add_argument("--json", action="store_true", help="Machine-readable output")
p_update.set_defaults(func=cmd_update)
# v0.1.4: one-command auto-detect-and-wire setup for any agent stack
from .setup import cmd_setup
p_setup = sub.add_parser(
"setup",
help="Auto-detect Hermes / Claude Code and wire SIBYL as the memory provider",
)
p_setup.add_argument(
"target", nargs="?", choices=list(["hermes", "claude-code", "codex"]),
help="Wire just this framework (default: detect all)",
)
p_setup.add_argument(
"--yes", "-y", action="store_true",
help="Skip prompts, accept defaults (still respects destructive-default-NO unless --force)",
)
p_setup.add_argument(
"--force", action="store_true",
help="Overwrite existing non-SIBYL memory provider configs",
)
p_setup.add_argument(
"--dry-run", action="store_true",
help="Print what would change without writing",
)
p_setup.add_argument(
"--hermes-home", default=None,
help="Override HERMES_HOME autodetection",
)
p_setup.add_argument(
"--claude-settings", default=None,
help="Override ~/.claude.json autodetection",
)
p_setup.add_argument(
"--codex-config", default=None,
help="Override ~/.codex/config.toml autodetection",
)
p_setup.set_defaults(func=cmd_setup)
p_migrate = sub.add_parser(
"migrate",
help="Guided: back up existing memory/agent files, wire Sibyl, populate Sibyl Memory, optionally slim the originals",
)
p_migrate.add_argument(
"--backup-dir", default=None,
help="Where to write the timestamped backup (default: your home directory)",
)
p_migrate.add_argument(
"--no-debloat", action="store_true",
help="Skip the optional trim step (back up + wire + extract + verify only)",
)
p_migrate.add_argument(
"--yes", "-y", action="store_true",
help="Skip the initial confirm (the trim step still always asks separately)",
)
p_migrate.add_argument(
"--force", action="store_true",
help="Overwrite an existing non-sibyl memory provider when wiring a harness "
"(without this, migrate stops at that harness and tells you to re-run with --force)",
)
p_migrate.set_defaults(func=cmd_migrate)
return p
def cmd_memory(args: argparse.Namespace) -> int:
"""Read-only inspection of the local memory store (PKG-4, VRTX/deadguy beta).
sibyl memory list [category] list entities
sibyl memory search <query> full-text search across tiers
sibyl memory recall <cat> <nm> recall one entity by category + name
Opens the resolved DB read-only via the SDK; never writes. Respects --db so
you can inspect any split-brain store that `sibyl status` surfaces.
"""
from sibyl_memory_client import MemoryClient
db_path = Path(args.db).expanduser()
print()
if not db_path.exists():
print(a.warn_line(f"No memory store at {db_path}."))
print(a.dim(" Run `sibyl status` to see every store on this machine."))
return 1
client = MemoryClient.local(path=db_path)
op = getattr(args, "mem_cmd", None)
if op == "list":
rows = client.list_entities(category=args.category, limit=args.limit)
if not rows:
print(a.dim("(no entities)"))
return 0
print(a.eyebrow(f"entities ({len(rows)})"))
for r in rows:
# CLI-7: tolerate SDK rows missing category/name keys.
cat = r.get("category", "?")
name = r.get("name", "?")
print(a.kv(f"{cat}/{name}", r.get("status") or "-"))
return 0
if op == "search":
hits = client.search(args.query, limit=args.limit)
if not hits:
print(a.dim(f"(no matches for {args.query!r})"))
return 0
print(a.eyebrow(f"matches ({len(hits)})"))
for h in hits:
snip = (h.get("snippet") or "").replace("\n", " ")[:100]
print(a.kv(f"[{h.get('tier') or '-'}] {h.get('key') or '-'}", snip))
return 0
if op == "recall":
try:
ent = client.get_entity(args.category, args.name)
except Exception as e:
print(a.warn_line(str(e)))
return 1
# CLI-7: tolerate SDK rows missing category/name keys.
print(a.eyebrow(f"{ent.get('category', args.category)}/{ent.get('name', args.name)}"))
print(a.kv("status", ent.get("status") or "-"))
print(a.kv("updated", ent.get("updated_at") or "-"))
body = ent.get("body")
print(body if isinstance(body, str) else json.dumps(body, indent=2, ensure_ascii=False))
return 0
print(a.warn_line("Usage: sibyl memory {list|search|recall} ..."))
return 1
def main(argv: list[str] | None = None) -> int:
parser = build_parser()
args = parser.parse_args(argv)
try:
return args.func(args)
except KeyboardInterrupt:
print(red("\nInterrupted."))
return 130
if __name__ == "__main__":
sys.exit(main())
|