@pyric/cli 0.1.0-alpha.9

package/dist/serve/docs-ui/docs/pyric-cli-bridge-reference-api.md

@@ -0,0 +1,419 @@
+
+<!-- Generated from published package declarations via TypeDoc. Do not edit by hand; run bun run docs:api:generate. -->
+
+## Interfaces
+
+<a id="bridge"></a>
+
+### Bridge
+
+#### Properties
+
+| Property | Modifier | Type | Description |
+| :------ | :------ | :------ | :------ |
+| <a id="instanceid"></a> `instanceId` | `readonly` | `string` | Stable per-process identity (see HealthReport.instanceId). |
+| <a id="project"></a> `project` | `readonly` | `string` | - |
+| <a id="startedat"></a> `startedAt` | `readonly` | `string` | - |
+| <a id="version"></a> `version` | `readonly` | `string` | - |
+
+#### Methods
+
+<a id="dispatch"></a>
+
+##### dispatch()
+
+```ts
+dispatch(name: string, args: Record<string, unknown>): Promise<BridgeToolResult>;
+```
+
+Dispatch a tool call to the connected sandbox peer.
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `name` | `string` |
+| `args` | `Record`\<`string`, `unknown`\> |
+
+###### Returns
+
+`Promise`\<`BridgeToolResult`\>
+
+<a id="dispatchworkerop"></a>
+
+##### dispatchWorkerOp()
+
+```ts
+dispatchWorkerOp(op: WorkerOpPayload): Promise<unknown>;
+```
+
+Relay a generic worker op to the peer's SharedWorker. Resolves with the
+worker's `res.value`; rejects with an Error carrying `.code` on worker
+failure, timeout, no peer, or a peer without the worker relay.
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `op` | `WorkerOpPayload` |
+
+###### Returns
+
+`Promise`\<`unknown`\>
+
+<a id="handlesandboxmessage"></a>
+
+##### handleSandboxMessage()
+
+```ts
+handleSandboxMessage(msg: BridgeMessage, generation?: number): void;
+```
+
+Handle a message from the sandbox peer (tool-result, pong, …).
+`generation` is the peer generation the transport captured at
+registration; when provided, `worker-res`/`worker-snap` frames from a
+stale generation are dropped.
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `msg` | `BridgeMessage` |
+| `generation?` | `number` |
+
+###### Returns
+
+`void`
+
+<a id="health"></a>
+
+##### health()
+
+```ts
+health(): HealthReport;
+```
+
+/health endpoint payload.
+
+###### Returns
+
+[`HealthReport`](#healthreport)
+
+<a id="issandboxconnected"></a>
+
+##### isSandboxConnected()
+
+```ts
+isSandboxConnected(): boolean;
+```
+
+True if a sandbox peer is currently registered.
+
+###### Returns
+
+`boolean`
+
+<a id="peergeneration"></a>
+
+##### peerGeneration()
+
+```ts
+peerGeneration(): number;
+```
+
+Generation counter of the CURRENT peer registration (0 = no peer has
+ever registered). The transport captures this right after registering
+and tags every inbound message with it, so a frame arriving on a
+REPLACED peer's socket (tab refresh mid-flight) can never resolve a new
+peer's pending call or deliver a stale subscription snapshot.
+
+###### Returns
+
+`number`
+
+<a id="recordtoolevent"></a>
+
+##### recordToolEvent()
+
+```ts
+recordToolEvent(event: BridgeToolEvent): void;
+```
+
+Record a tool event in the bridge's audit pipeline. In-process sandbox
+tools use this path; forwarded tools log inside dispatch().
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `event` | `BridgeToolEvent` |
+
+###### Returns
+
+`void`
+
+<a id="registersandboxpeer"></a>
+
+##### registerSandboxPeer()
+
+```ts
+registerSandboxPeer(
+   send: SendToPeer,
+   tools: string[],
+   sandboxId: string,
+   capabilities?: string[],
+   onReplaced?: () => void): () => void;
+```
+
+Register a browser-side peer. Returns a disconnect function the
+caller MUST invoke when the WS closes. Last-wins: a new
+registration disconnects the previous peer (its pending calls
+fail with a clear error).
+
+`capabilities` come from the peer's `hello` — the bridge only sends
+`worker-*` frames to a peer that declared `'worker-relay'`.
+
+`onReplaced` fires when a NEWER registration displaces this peer. The
+transport MUST use it to close the old socket: the browser side's
+close handler tears down its relayed worker subscriptions — without
+this, a replaced tab's SharedWorker listeners would live until the tab
+closed, streaming snaps the bridge drops as stale-generation forever.
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `send` | `SendToPeer` |
+| `tools` | `string`[] |
+| `sandboxId` | `string` |
+| `capabilities?` | `string`[] |
+| `onReplaced?` | () => `void` |
+
+###### Returns
+
+```ts
+(): void;
+```
+
+###### Returns
+
+`void`
+
+<a id="subscribeworker"></a>
+
+##### subscribeWorker()
+
+```ts
+subscribeWorker(sub: WorkerSubPayload, onSnap: (value: unknown) => void): () => void;
+```
+
+Register a worker subscription. Ownership lives HERE: the registry
+survives peer churn, and every registered sub is re-issued to a new
+peer on registration (RTDB value / auth-state subs re-deliver a fresh
+initial snapshot, so replay is cursor-free). `onSnap` receives every
+relayed snap value verbatim — including the worker host's
+`{ __error: { code, message } }` establishment-failure convention.
+Returns the unsubscribe function.
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `sub` | `WorkerSubPayload` |
+| `onSnap` | (`value`: `unknown`) => `void` |
+
+###### Returns
+
+```ts
+(): void;
+```
+
+###### Returns
+
+`void`
+
+<a id="toolnames"></a>
+
+##### toolNames()
+
+```ts
+toolNames(): string[];
+```
+
+Tool names the bridge currently exposes to MCP.
+
+###### Returns
+
+`string`[]
+
+***
+
+<a id="bridgeoptions"></a>
+
+### BridgeOptions
+
+#### Properties
+
+| Property | Type | Description |
+| :------ | :------ | :------ |
+| <a id="calltimeoutms"></a> `callTimeoutMs?` | `number` | Per-call request timeout in ms when forwarding to the browser. Defaults to 30s; the bridge rejects the MCP call with a clear "sandbox call timed out" error after this. |
+| <a id="ontoolevent"></a> `onToolEvent?` | (`event`: `BridgeToolEvent`) => `void` | Hook called whenever a tool finishes (success or failure). Use this for the audit log — write the entry to disk here. The bridge does not own audit-log persistence. |
+| <a id="project-1"></a> `project?` | `string` | Sandbox label surfaced in /health and audit-log paths. |
+| <a id="version-1"></a> `version` | `string` | Bridge version surfaced in /health + Hello messages. |
+
+***
+
+<a id="healthreport"></a>
+
+### HealthReport
+
+Health report returned by the bridge's `GET /health` endpoint.
+
+#### Properties
+
+| Property | Type | Description |
+| :------ | :------ | :------ |
+| <a id="instanceid-1"></a> `instanceId` | `string` | Random identity, stable for this bridge process's lifetime. The discovery pointer (`.pyric/serve.json`) records the same value, so a proxy can confirm it reached the SAME server the pointer names — two sandboxes can collide on one port across loopback families (IPv4 `*:P` + IPv6 `[::1]:P`), and `mode` alone can't tell them apart. (Not `version` — that's hardcoded.) |
+| <a id="mode"></a> `mode` | `"sandbox"` | Constant provenance marker: the programmatic bridge is sandbox-only. |
+| <a id="project-2"></a> `project` | `string` | Sandbox identifier surfaced in health and audit metadata. |
+| <a id="sandboxconnected"></a> `sandboxConnected` | `boolean` | Whether a browser tab is currently connected over `/sandbox`. |
+| <a id="startedat-1"></a> `startedAt` | `string` | ISO timestamp the bridge started. |
+| <a id="status"></a> `status` | `"ok"` | - |
+| <a id="version-2"></a> `version` | `string` | Bridge package version. |
+
+***
+
+<a id="serverhandle"></a>
+
+### ServerHandle
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="auditlogpath"></a> `auditLogPath` | `readonly` | `string` |
+| <a id="bridge-1"></a> `bridge` | `readonly` | [`Bridge`](#bridge) |
+| <a id="port"></a> `port` | `readonly` | `number` |
+| <a id="url"></a> `url` | `readonly` | `string` |
+
+#### Methods
+
+<a id="stop"></a>
+
+##### stop()
+
+```ts
+stop(): Promise<void>;
+```
+
+###### Returns
+
+`Promise`\<`void`\>
+
+***
+
+<a id="startserveroptions"></a>
+
+### StartServerOptions
+
+#### Properties
+
+| Property | Type | Description |
+| :------ | :------ | :------ |
+| <a id="allowedhosts"></a> `allowedHosts?` | `string`[] | Extra hostnames allowed past the WS-upgrade rebinding/origin guard (besides the loopback set the bridge binds to). Mirrors serve's `--allowed-host`. |
+| <a id="auditwriter"></a> `auditWriter?` | `AuditWriter` | Override the audit writer (testing). |
+| <a id="disableauditlog"></a> `disableAuditLog?` | `boolean` | Disable the audit log writer (useful in tests). |
+| <a id="logger"></a> `logger?` | `BridgeLogger` | Premortem #U1 — logger; defaults to stderr `[pyric]` prefix. |
+| <a id="maxsessions"></a> `maxSessions?` | `number` | Premortem #A2 — refuse new sessions when this many are active. Default 50. |
+| <a id="port-1"></a> `port?` | `number` | Port to bind. Default: 5174. Env: PYRIC_PORT. |
+| <a id="project-3"></a> `project?` | `string` | Sandbox label surfaced in health and audit metadata. |
+| <a id="sessionidlems"></a> `sessionIdleMs?` | `number` | Premortem #A2 — kill idle sessions after this many ms. Default 10 min. |
+| <a id="silent"></a> `silent?` | `boolean` | Convenience: install a silent logger (tests). |
+
+## Variables
+
+<a id="default_bridge_port"></a>
+
+### DEFAULT\_BRIDGE\_PORT
+
+```ts
+const DEFAULT_BRIDGE_PORT: 5174 = 5174;
+```
+
+Default port the standalone bridge binds to.
+
+***
+
+<a id="default_health_path"></a>
+
+### DEFAULT\_HEALTH\_PATH
+
+```ts
+const DEFAULT_HEALTH_PATH: "/health" = "/health";
+```
+
+Default health endpoint path.
+
+***
+
+<a id="default_mcp_path"></a>
+
+### DEFAULT\_MCP\_PATH
+
+```ts
+const DEFAULT_MCP_PATH: "/mcp" = "/mcp";
+```
+
+Default HTTP path the MCP client connects to.
+
+***
+
+<a id="default_sandbox_path"></a>
+
+### DEFAULT\_SANDBOX\_PATH
+
+```ts
+const DEFAULT_SANDBOX_PATH: "/sandbox" = "/sandbox";
+```
+
+Default WS path the browser connects to.
+
+## Functions
+
+<a id="createbridge"></a>
+
+### createBridge()
+
+```ts
+function createBridge(opts: BridgeOptions): Bridge;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `opts` | [`BridgeOptions`](#bridgeoptions) |
+
+#### Returns
+
+[`Bridge`](#bridge)
+
+***
+
+<a id="startserver"></a>
+
+### startServer()
+
+```ts
+function startServer(opts?: StartServerOptions): Promise<ServerHandle>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `opts?` | [`StartServerOptions`](#startserveroptions) |
+
+#### Returns
+
+`Promise`\<[`ServerHandle`](#serverhandle)\>

package/dist/serve/docs-ui/docs/pyric-cli-bridge.md

@@ -0,0 +1,99 @@
+# `@pyric/cli/bridge`
+
+Bridge between an external MCP client (Claude Code, Cursor) and a browser-resident pyric sandbox.
+
+Most users never import this directly. They use the `pyric` CLI (`pyric bridge`
+or `pyric dev --bridge`). This module is the implementation underneath.
+
+## What this does
+
+Pyric's headline value is that an AI agent can see and act on the **same browser context** the developer sees: the in-page sandbox, its state, its rules, its event log. External MCP clients (Claude Code, Cursor) run in a terminal, not a browser tab. This bridge connects the two:
+
+```
+external MCP client ──HTTP MCP──► pyric bridge (Node) ◄──WebSocket── browser tab (sandbox)
+```
+
+The bridge process exposes:
+
+- `POST /mcp`: MCP-over-HTTP using `@modelcontextprotocol/sdk`.
+- `GET /sandbox` (WebSocket Upgrade): the browser tab connects here.
+- `GET /health`: diagnostic endpoint returning `{ mode, sandboxConnected, ... }`.
+
+Bound to `127.0.0.1` only. The CLI starts the bridge in **sandbox** mode: data-plane
+tool calls forward to the connected browser. Control-plane / production Firebase
+operations are not registered.
+
+## Two entry points, one package
+
+Conditional exports route to the right bundle based on runtime:
+
+```jsonc
+{
+  "exports": {
+    "./bridge": {
+      "node":    { "import": "./dist/bridge/server.js" },
+      "browser": { "import": "./dist/bridge/client.js" }
+    }
+  }
+}
+```
+
+- **Node** (`import { startServer } from '@pyric/cli/bridge'`): gets `createBridge`, `startServer`. (The Vite integration is `pyricSandbox({ bridge })` in `@pyric/cli/vite`.)
+- **Browser**: gets `connectBridge`.
+
+The wire format (shared types) lives in `protocol.ts` and is referenced from both bundles.
+
+## CLI
+
+```bash
+pyric bridge                          # sandbox bridge on 127.0.0.1:5174
+pyric bridge --port 6000 --project demo
+pyric dev --bridge                    # mount MCP on the dev-server origin
+```
+
+## Programmatic use
+
+```ts
+import { startServer } from '@pyric/cli/bridge';
+
+const handle = await startServer({ mode: 'sandbox', port: 5174 });
+// later
+await handle.stop();
+```
+
+For Vite users, the bridge is folded into the `pyricSandbox` plugin: one plugin
+does the `firebase/*` → sandbox swap **and** the bridge:
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vite';
+import { pyricSandbox } from '@pyric/cli/vite';
+
+export default defineConfig({ plugins: [pyricSandbox({ bridge: true })] });
+```
+
+The plugin mounts the bridge on Vite's own dev server at `/__pyric/mcp`,
+`/__pyric/health`, and `/__pyric/sandbox` (WS), so the bridge shares Vite's port
+instead of running as a sidecar. The agent's tool-calls route through the
+SharedWorker, so the app, Pyric Studio, and the agent all share one sandbox. See
+[Use the Vite plugin](../pyric-cli-how-to-use-the-vite-plugin/#drive-the-sandbox-from-an-agent-bridge).
+
+## Browser side
+
+```ts
+import { initializeSandbox } from 'pyric/sandbox';
+import { connectBridge } from '@pyric/cli/bridge';
+
+const sandbox = initializeSandbox();
+// ... app uses sandbox normally ...
+
+// Connect to the running bridge (no-op in production builds).
+if (import.meta.env.DEV) {
+  connectBridge(sandbox);
+}
+```
+
+## See also
+
+- Agent tool inventory
+- [Wire Claude Code](../pyric-cli-tutorials-wire-claude-code/)

package/dist/serve/docs-ui/docs/pyric-cli-credentials-node-reference-api/index.html

@@ -0,0 +1,67 @@
+<!DOCTYPE html><html lang="en"> <head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>API reference: @pyric/cli/credentials/node · Pyric Studio</title><meta name="description" content="Published declarations for @pyric/cli/credentials/node."><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500;700&display=swap" rel="stylesheet"><link rel="stylesheet" href="/__pyric/ui/_astro/_slug_.CQYSemvw.css"></head> <body>  <header class="studio__bar"> <div class="studio__bar-inner"> <a class="studio__brand" href="/__pyric/ui/" aria-label="Pyric Studio">Pyric</a> <nav class="studio__nav" aria-label="Studio tabs"> <a class="studio__nav-tab" href="/__pyric/ui/"> Home </a><a class="studio__nav-tab" href="/__pyric/ui/firestore"> Firestore </a><a class="studio__nav-tab" href="/__pyric/ui/auth"> Auth </a><a class="studio__nav-tab" href="/__pyric/ui/rtdb"> RTDB </a><a class="studio__nav-tab" href="/__pyric/ui/storage"> Storage </a><a class="studio__nav-tab" href="/__pyric/ui/traffic"> Traffic </a><a class="studio__nav-tab" href="/__pyric/ui/settings"> Settings </a><a class="studio__nav-tab" href="/__pyric/ui/docs" aria-current="page"> Docs </a> </nav> </div> </header> <div class="docs-shell">  <details class="docs-nav-drawer"> <summary>Navigate</summary> <nav class="docs-nav" aria-label="Documentation"> <div class="docs-search" data-index-url="/__pyric/ui/docs/index.json"> <div class="docs-search-field"> <svg class="docs-search-icon" viewBox="0 0 16 16" width="14" height="14" aria-hidden="true"> <path d="M11.5 11.5 15 15M13 7A6 6 0 1 1 1 7a6 6 0 0 1 12 0Z" fill="none" stroke="currentColor" stroke-width="1.4" stroke-linecap="round"></path> </svg> <input type="text" class="docs-search-input" placeholder="Search docs" aria-label="Search docs" autocomplete="off" spellcheck="false"> <kbd class="docs-search-kbd">⌘K</kbd> </div> <ul class="docs-search-results" hidden></ul> </div> <script type="module">let i=null;function d(t){return i||(i=fetch(t).then(e=>e.json())),i}function l(t,e){return t.title.toLowerCase().includes(e)||t.excerpt.toLowerCase().includes(e)?!0:t.headings.some(r=>r.text.toLowerCase().includes(e))}function u(t,e,r){if(e.innerHTML="",t.length===0){e.hidden=!1;{const n=document.createElement("li");n.className="docs-search-empty",n.textContent="No matches",e.appendChild(n)}return}e.hidden=!1;for(const n of t.slice(0,8)){const s=document.createElement("li"),c=document.createElement("a");c.href=n.path;const o=document.createElement("span");o.className="docs-search-result-title",o.textContent=n.title;const a=document.createElement("span");a.className="docs-search-result-meta",a.textContent=[n.group,n.section].filter(Boolean).join(" / "),c.append(o,a),s.appendChild(c),e.appendChild(s)}}document.querySelectorAll(".docs-search").forEach(t=>{const e=t.dataset.indexUrl,r=t.querySelector(".docs-search-input"),n=t.querySelector(".docs-search-results");r.addEventListener("input",async()=>{const s=r.value.trim().toLowerCase();if(!s){n.hidden=!0,n.innerHTML="";return}const{pages:c}=await d(e);r.value.trim().toLowerCase()===s&&u(c.filter(o=>l(o,s)),n)}),r.addEventListener("focus",()=>{d(e),n.childElementCount>0&&(n.hidden=!1)}),r.addEventListener("keydown",s=>{s.key==="Escape"&&(r.value="",n.hidden=!0,n.innerHTML="",r.blur())}),r.addEventListener("blur",()=>{window.setTimeout(()=>{n.hidden=!0},150)})});document.addEventListener("keydown",t=>{if(!(t.metaKey||t.ctrlKey)||t.key.toLowerCase()!=="k")return;const e=[...document.querySelectorAll(".docs-search-input")].find(r=>r.offsetParent!==null);e&&(t.preventDefault(),e.focus(),e.select())});</script> <a class="docs-nav-toplink" href="/__pyric/ui/docs/overview/"> Overview </a><details class="docs-nav-group"> <summary>Run locally</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/start-building/"> Quickstart </a> </li><li> <a href="/__pyric/ui/docs/how-the-swap-works/"> How the swap works </a> </li><li> <a href="/__pyric/ui/docs/set-up-your-agent/"> Connect an agent </a> </li><li> <a href="/__pyric/ui/docs/test-in-node/"> Test in Node </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Develop with Firebase APIs</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/sign-in-and-manage-users/"> Sign in and manage users </a> </li><li> <a href="/__pyric/ui/docs/store-and-query-data/"> Store and query data </a> </li><li> <a href="/__pyric/ui/docs/sync-realtime-data/"> Sync realtime data </a> </li><li> <a href="/__pyric/ui/docs/store-files/"> Store files </a> </li><li> <a href="/__pyric/ui/docs/receive-messages/"> Receive messages </a> </li><li> <a href="/__pyric/ui/docs/run-ai-logic-locally/"> Run AI Logic locally </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-how-to-run-rtdb-onvaluecreated/"> Run an RTDB function locally </a> </li><li> <a href="/__pyric/ui/docs/which-data-service/"> Which data service? </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Inspect and correct</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <h2 class="docs-nav-heading"> Inspect the sandbox </h2> <ul> <li> <a href="/__pyric/ui/docs/see-whats-happening/"> Traffic &amp; rule verdicts </a> </li><li> <a href="/__pyric/ui/docs/read-a-denial/"> Read a denial and understand it </a> </li><li> <a href="/__pyric/ui/docs/shape-your-data/"> Seed, snapshot, replay </a> </li><li> <a href="/__pyric/ui/docs/watch-and-review/"> Review agent activity </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading"> Correct Security Rules </h2> <ul> <li> <a href="/__pyric/ui/docs/secure-it-with-rules/"> Security Rules </a> </li><li> <a href="/__pyric/ui/docs/simulate-and-lint/"> Simulate and lint before you deploy </a> </li><li> <a href="/__pyric/ui/docs/rules-patterns/"> Rules patterns </a> </li><li> <a href="/__pyric/ui/docs/rules-standard-library/"> The rules standard library </a> </li><li> <a href="/__pyric/ui/docs/rtdb-rules-in-typescript/"> RTDB rules in TypeScript </a> </li><li> <a href="/__pyric/ui/docs/firestore-rules-limits/"> Rules limits </a> </li><li> <a href="/__pyric/ui/docs/whats-possible/"> Case studies </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading"> Work with an agent </h2> <ul> <li> <a href="/__pyric/ui/docs/what-your-agent-can-do/"> Work through an agent </a> </li><li> <a href="/__pyric/ui/docs/skills/"> Agent skills </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Verify the boundary</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/pyric-cli-how-to-verify-against-a-captured-session/"> Verify a captured session </a> </li><li> <a href="/__pyric/ui/docs/write-a-rules-test-suite/"> Write a rules test suite </a> </li><li> <a href="/__pyric/ui/docs/audit-your-rules/"> Audit rules and data </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Ship unchanged</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/ship-to-production/"> Ship to production </a> </li><li> <a href="/__pyric/ui/docs/set-up-the-project/"> Set up the Firebase project </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Conformance</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/how-we-know-it-matches-firebase/"> Conformance </a> </li><li> <a href="/__pyric/ui/docs/whats-experimental/"> What&#39;s experimental </a> </li><li> <a href="/__pyric/ui/docs/pyric-conformance-scores/"> Conformance scores </a> </li><li> <a href="/__pyric/ui/docs/pyric-app-compat/"> App </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-compat/"> Firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth-compat/"> Auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-database-compat/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage-compat/"> Storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules-compat/"> Rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-compat/"> Messaging </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-compat/"> AI Logic </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-functions-rtdb-compat/"> Functions · RTDB </a> </li> </ul> </div> </div> </details> <details class="docs-nav-group" open> <summary>Reference</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/pyric-cli/"> @pyric/cli </a> </li><li> <a href="/__pyric/ui/docs/pyric-explanation-versioning-and-compatibility/"> pyric </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore/"> pyric / firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules/"> pyric / rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox/"> pyric / sandbox </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage/"> pyric / storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth/"> pyric / auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-database/"> pyric / database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-app/"> pyric-admin / app </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-firestore/"> pyric-admin / firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-auth/"> pyric-admin / auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-database/"> pyric-admin / database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-storage/"> pyric-admin / storage </a> </li><li> <a href="/__pyric/ui/docs/ui/"> @pyric/ui </a> </li><li> <a href="/__pyric/ui/docs/api-reference/" aria-current="true"> API reference </a> </li> </ul> </div> </div> </details> </nav> </details> <nav class="docs-nav" aria-label="Documentation"> <div class="docs-search" data-index-url="/__pyric/ui/docs/index.json"> <div class="docs-search-field"> <svg class="docs-search-icon" viewBox="0 0 16 16" width="14" height="14" aria-hidden="true"> <path d="M11.5 11.5 15 15M13 7A6 6 0 1 1 1 7a6 6 0 0 1 12 0Z" fill="none" stroke="currentColor" stroke-width="1.4" stroke-linecap="round"></path> </svg> <input type="text" class="docs-search-input" placeholder="Search docs" aria-label="Search docs" autocomplete="off" spellcheck="false"> <kbd class="docs-search-kbd">⌘K</kbd> </div> <ul class="docs-search-results" hidden></ul> </div>  <a class="docs-nav-toplink" href="/__pyric/ui/docs/overview/" id="nav-group-overview"> Overview </a><details class="docs-nav-group" id="nav-group-run-locally"> <summary>Run locally</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/start-building/"> Quickstart </a> </li><li> <a href="/__pyric/ui/docs/how-the-swap-works/"> How the swap works </a> </li><li> <a href="/__pyric/ui/docs/set-up-your-agent/"> Connect an agent </a> </li><li> <a href="/__pyric/ui/docs/test-in-node/"> Test in Node </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-develop-with-firebase-apis"> <summary>Develop with Firebase APIs</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/sign-in-and-manage-users/"> Sign in and manage users </a> </li><li> <a href="/__pyric/ui/docs/store-and-query-data/"> Store and query data </a> </li><li> <a href="/__pyric/ui/docs/sync-realtime-data/"> Sync realtime data </a> </li><li> <a href="/__pyric/ui/docs/store-files/"> Store files </a> </li><li> <a href="/__pyric/ui/docs/receive-messages/"> Receive messages </a> </li><li> <a href="/__pyric/ui/docs/run-ai-logic-locally/"> Run AI Logic locally </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-how-to-run-rtdb-onvaluecreated/"> Run an RTDB function locally </a> </li><li> <a href="/__pyric/ui/docs/which-data-service/"> Which data service? </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-inspect-and-correct"> <summary>Inspect and correct</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <h2 class="docs-nav-heading" id="nav-section-inspect-and-correct-inspect-the-sandbox"> Inspect the sandbox </h2> <ul> <li> <a href="/__pyric/ui/docs/see-whats-happening/"> Traffic &amp; rule verdicts </a> </li><li> <a href="/__pyric/ui/docs/read-a-denial/"> Read a denial and understand it </a> </li><li> <a href="/__pyric/ui/docs/shape-your-data/"> Seed, snapshot, replay </a> </li><li> <a href="/__pyric/ui/docs/watch-and-review/"> Review agent activity </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading" id="nav-section-inspect-and-correct-correct-security-rules"> Correct Security Rules </h2> <ul> <li> <a href="/__pyric/ui/docs/secure-it-with-rules/"> Security Rules </a> </li><li> <a href="/__pyric/ui/docs/simulate-and-lint/"> Simulate and lint before you deploy </a> </li><li> <a href="/__pyric/ui/docs/rules-patterns/"> Rules patterns </a> </li><li> <a href="/__pyric/ui/docs/rules-standard-library/"> The rules standard library </a> </li><li> <a href="/__pyric/ui/docs/rtdb-rules-in-typescript/"> RTDB rules in TypeScript </a> </li><li> <a href="/__pyric/ui/docs/firestore-rules-limits/"> Rules limits </a> </li><li> <a href="/__pyric/ui/docs/whats-possible/"> Case studies </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading" id="nav-section-inspect-and-correct-work-with-an-agent"> Work with an agent </h2> <ul> <li> <a href="/__pyric/ui/docs/what-your-agent-can-do/"> Work through an agent </a> </li><li> <a href="/__pyric/ui/docs/skills/"> Agent skills </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-verify-the-boundary"> <summary>Verify the boundary</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/pyric-cli-how-to-verify-against-a-captured-session/"> Verify a captured session </a> </li><li> <a href="/__pyric/ui/docs/write-a-rules-test-suite/"> Write a rules test suite </a> </li><li> <a href="/__pyric/ui/docs/audit-your-rules/"> Audit rules and data </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-ship-unchanged"> <summary>Ship unchanged</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/ship-to-production/"> Ship to production </a> </li><li> <a href="/__pyric/ui/docs/set-up-the-project/"> Set up the Firebase project </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-conformance"> <summary>Conformance</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/how-we-know-it-matches-firebase/"> Conformance </a> </li><li> <a href="/__pyric/ui/docs/whats-experimental/"> What&#39;s experimental </a> </li><li> <a href="/__pyric/ui/docs/pyric-conformance-scores/"> Conformance scores </a> </li><li> <a href="/__pyric/ui/docs/pyric-app-compat/"> App </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-compat/"> Firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth-compat/"> Auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-database-compat/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage-compat/"> Storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules-compat/"> Rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-compat/"> Messaging </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-compat/"> AI Logic </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-functions-rtdb-compat/"> Functions · RTDB </a> </li> </ul> </div> </div> </details> <details class="docs-nav-group" id="nav-group-reference" open> <summary>Reference</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/pyric-cli/"> @pyric/cli </a> </li><li> <a href="/__pyric/ui/docs/pyric-explanation-versioning-and-compatibility/"> pyric </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore/"> pyric / firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules/"> pyric / rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox/"> pyric / sandbox </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage/"> pyric / storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth/"> pyric / auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-database/"> pyric / database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-app/"> pyric-admin / app </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-firestore/"> pyric-admin / firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-auth/"> pyric-admin / auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-database/"> pyric-admin / database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-storage/"> pyric-admin / storage </a> </li><li> <a href="/__pyric/ui/docs/ui/"> @pyric/ui </a> </li><li> <a href="/__pyric/ui/docs/api-reference/" aria-current="true"> API reference </a> </li> </ul> </div> </div> </details> </nav> <main class="doc-main"> <nav class="docs-breadcrumbs" aria-label="Breadcrumb"> <ol> <li>  <a href="/__pyric/ui/docs/api-reference/">API reference</a> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span>@pyric/cli</span> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span aria-current="page">@pyric/cli/credentials/node</span> </li> </ol> </nav> <header class="api-reference-header"> <p class="api-reference-kicker">API reference</p> <h1><code>@pyric/cli/credentials/node</code></h1> <p class="api-reference-meta"> 2 published symbols from <code>@pyric/cli</code> </p> <p class="api-reference-source">
+Generated from the TypeScript declarations shipped at this import path.
+</p>  </header> <article class="prose api-reference-body">  <!-- Generated from published package declarations via TypeDoc. Do not edit by hand; run bun run docs:api:generate. -->
+<h2 id="functions">Functions</h2>
+<p><a id="fromadc"></a></p>
+<h3 id="fromadc">fromAdc()</h3>
+<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">function</span><span style="color:#61AFEF"> fromAdc</span><span style="color:#ABB2BF">(</span></span>
+<span class="line"><span style="color:#E06C75;font-style:italic">   projectId</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">string</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#E06C75;font-style:italic">   env</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">ProcessEnv</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#E06C75;font-style:italic">path</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">string</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#ABB2BF">&#x3C;</span><span style="color:#E5C07B">ProjectScope</span><span style="color:#ABB2BF">>;</span></span></code></pre>
+<p>Build a <code>ProjectScope</code> from ADC, or <code>null</code> if no ADC file is present. The
+project is supplied by the caller — an ADC user credential isn’t bound to one
+(<code>--project</code> / <code>.firebaserc</code>).</p>
+<h4 id="parameters">Parameters</h4>
+<div class="table-scroll">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>projectId</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>env?</code></td><td align="left"><code>ProcessEnv</code></td></tr><tr><td align="left"><code>path?</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<h4 id="returns">Returns</h4>
+<p><code>Promise</code>&#x3C;<code>ProjectScope</code>></p>
+<hr>
+<p><a id="fromserviceaccount"></a></p>
+<h3 id="fromserviceaccount">fromServiceAccount()</h3>
+<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">function</span><span style="color:#61AFEF"> fromServiceAccount</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">saJsonOrPath</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">string</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#ABB2BF">&#x3C;</span><span style="color:#E5C07B">ProjectScope</span><span style="color:#ABB2BF">>;</span></span></code></pre>
+<p>Read the service account from a JSON file and return a
+<code>ProjectScope</code> whose <code>resolveToken</code> is memoized internally.</p>
+<p>The JSON file path can be:</p>
+<ul>
+<li>An absolute / relative filesystem path (Node only).</li>
+<li>A base64-encoded JSON string (when prefixed with <code>base64:</code>),
+for environments that ship the SA in an env var.</li>
+</ul>
+<h4 id="parameters-1">Parameters</h4>
+<div class="table-scroll">
+
+
+
+
+
+
+
+
+
+
+
+
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>saJsonOrPath</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<h4 id="returns-1">Returns</h4>
+<p><code>Promise</code>&#x3C;<code>ProjectScope</code>></p>  </article> </main> <aside class="doc-toc api-symbols" aria-label="API symbols"> <h2 class="doc-toc-heading">Symbols</h2> <input class="api-symbol-filter" type="search" placeholder="Filter symbols" aria-label="Filter API symbols" data-api-symbol-filter> <div class="api-symbol-groups" data-api-symbol-groups> <section class="api-symbol-group" data-api-symbol-group> <a class="api-symbol-kind" href="#functions"> Functions </a> <ul> <li data-api-symbol="fromadc()"> <a href="#fromadc">fromAdc()</a> </li><li data-api-symbol="fromserviceaccount()"> <a href="#fromserviceaccount">fromServiceAccount()</a> </li> </ul> </section> <p class="api-symbol-empty" data-api-symbol-empty hidden>No matching symbols</p> </div> </aside> </div> <script type="module">const a=document.querySelector("[data-api-symbol-filter]"),d=[...document.querySelectorAll("[data-api-symbol-group]")],n=document.querySelector("[data-api-symbol-empty]");a?.addEventListener("input",()=>{const t=a.value.trim().toLowerCase();let o=0;for(const i of d){let e=0;i.querySelectorAll("[data-api-symbol]").forEach(l=>{const r=!t||(l.dataset.apiSymbol??"").includes(t);l.hidden=!r,r&&e++}),i.hidden=e===0,o+=e}n&&(n.hidden=o>0)});</script> <script type="module">const s=new Map;document.querySelectorAll('.doc-toc a[href^="#"]').forEach(t=>s.set(decodeURIComponent(t.hash.slice(1)),t));if(s.size>0){const t=new Set,n=()=>{let o=null;for(const e of s.keys())if(t.has(e)){o=e;break}s.forEach((e,c)=>e.classList.toggle("active",c===o))},r=new IntersectionObserver(o=>{for(const e of o)e.isIntersecting?t.add(e.target.id):t.delete(e.target.id);n()},{rootMargin:"-72px 0px -60% 0px"});s.forEach((o,e)=>{const c=document.getElementById(e);c&&r.observe(c)})}</script> <script type="module">document.querySelector('.studio__nav [aria-current="page"]')?.scrollIntoView({block:"nearest",inline:"center"});</script> </body> </html>