npm - @pyric/cli - Versions diffs - 0.1.0-alpha.9 - Mend

@pyric/cli 0.1.0-alpha.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1169) hide show

package/dist/serve/docs-ui/docs/pyric-cli-reference-cli/index.html ADDED Viewed

@@ -0,0 +1,404 @@
+<!DOCTYPE html><html lang="en"> <head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>pyric CLI reference · Pyric Studio</title><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/" aria-current="true"> @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/"> 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/" aria-current="true"> @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/"> 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/pyric-cli/">@pyric/cli</a> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span>Reference</span> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span aria-current="page">pyric CLI reference</span> </li> </ol> </nav>  <article class="prose">  <h1 id="pyric-cli-reference"><code>pyric</code> CLI reference</h1>
+<p>The complete command + flag surface of the <code>pyric</code> binary. This is the
+authoritative source for flags, defaults, and exit codes: guides and tutorials
+link here rather than restating them.</p>
+<p>Run <code>pyric --help</code> for the same surface inline, or <code>pyric --version</code>.</p>
+<h2 id="conventions">Conventions</h2>
+<ul>
+<li><code>&#x3C;required></code> arguments; <code>[optional]</code> arguments and flags.</li>
+<li>Flags accept <code>--flag value</code> or <code>--flag=value</code>.</li>
+<li>Unless noted, commands exit <strong>0</strong> on success, <strong>1</strong> on a usage error, and
+<strong>2</strong> on a runtime error. Specific non-standard exit codes are called out
+per command.</li>
+</ul>
+<h2 id="environment-variables">Environment variables</h2>
+<div class="table-scroll">
+<table><thead><tr><th>Variable</th><th>Used by</th><th>Meaning</th></tr></thead><tbody><tr><td><code>PYRIC_PORT</code></td><td><code>bridge</code></td><td>Bridge port (default 5174).</td></tr><tr><td><code>PYRIC_PROJECT</code></td><td><code>bridge</code>, <code>verify --engine rules-test-api</code></td><td>Project id label (falls back to the <code>.firebaserc</code> default).</td></tr><tr><td><code>PYRIC_VERBOSE</code></td><td>all</td><td>Verbose logging when set.</td></tr><tr><td><code>FIREBASE_SA_BASE64</code></td><td><code>verify --engine rules-test-api|both</code></td><td>base64-encoded service-account JSON for the hosted Rules Test API.</td></tr><tr><td><code>GOOGLE_APPLICATION_CREDENTIALS</code></td><td><code>verify --engine rules-test-api|both</code></td><td>Filesystem path to service-account JSON for the hosted Rules Test API.</td></tr></tbody></table></div>
+<p>Local sandbox commands (<code>dev</code>, <code>init</code>, <code>snapshot</code>, <code>bridge</code>, <code>mcp</code>, <code>verify</code>
+with the default <code>sandbox</code> engine, and every service-first rules or index
+command) need no credentials. Hosted Rules Test API verification (<code>--engine rules-test-api</code> or <code>both</code>) needs a project id plus <code>FIREBASE_SA_BASE64</code> or
+<code>GOOGLE_APPLICATION_CREDENTIALS</code> (or ADC). See
+<code>@pyric/cli/credentials/node</code>.</p>
+<hr>
+<h2 id="local-development">Local development</h2>
+<p><a id="pyric-dev"></a></p>
+<h3 id="pyric-dev-flags"><code>pyric dev [flags]</code></h3>
+<p>Serve the app locally with the pyric sandbox standing in for Firebase. Unmodified
+<code>firebase/*</code> imports resolve, via a served import map, to a sandbox running in a
+<strong>SharedWorker by default</strong> (one authoritative backend shared across all tabs;
+durable in the browser’s IndexedDB; service adapters use the per-tab in-page
+sandbox only when SharedWorker is unavailable). The current bundle still
+constructs that inactive fallback primitive eagerly; it is not a second routed
+backend. <code>firestore.rules</code> is installed and hot-reloaded over SSE.</p>
+<div class="table-scroll">
+<table><thead><tr><th>Flag</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>--port &#x3C;n></code></td><td><code>3473</code></td><td>Port to serve on (“FIRE” on a phone keypad); scans forward when taken.</td></tr><tr><td><code>--host &#x3C;h></code></td><td><code>localhost</code></td><td>Host to bind.</td></tr><tr><td><code>--persist</code></td><td>off</td><td>Persist sandbox state (docs + auth users) to a committable <code>.pyric/state/state.json</code>. Once a state file exists it wins; <code>--seed</code> then applies only into an empty sandbox. (On the SharedWorker path data is already durable in IndexedDB; this adds the on-disk, shareable copy.)</td></tr><tr><td><code>--fresh</code></td><td>off</td><td>Requires <code>--persist</code>: errors otherwise (there’s no state file to discard). Discards the existing state file and re-seeds from scratch. Does <strong>not</strong> clear the browser’s IndexedDB, so a browser tab with existing sandbox data keeps it and writes it right back into the new file; also clear site data (or use a private window) for a full reset.</td></tr><tr><td><code>--seed &#x3C;file></code></td><td>none</td><td>Load a <code>"collection/doc" → fields</code> JSON map admin-style before app code runs. Also accepts a <code>pyric snapshot</code> state file (detected by its <code>version</code> key), seeds docs + auth users. Applies only into an empty sandbox: if it already holds restored/lived data (a state file, or IndexedDB from an earlier session even without <code>--persist</code>), the seed is skipped and a console line explains why.</td></tr><tr><td><code>--no-capture</code></td><td>capture on</td><td>Disable the session capture. By default pyric dev writes <code>.pyric/last-session.json</code> for <code>pyric verify</code> to replay. Captures use <code>pyric.verify.fixture.v1</code>, with one event timeline and per-service Firestore/RTDB rules + state blocks.</td></tr><tr><td><code>--no-watch</code></td><td>watch on</td><td>Disable <code>firestore.rules</code> hot-reload.</td></tr><tr><td><code>--no-open</code></td><td>auto-open on</td><td>Don’t auto-open the browser. (Auto-open is already suppressed under <code>--json</code>, no TTY, and CI.)</td></tr><tr><td><code>--no-cache</code></td><td>cache on</td><td>Rebuild the served SDK + worker bundles instead of using <code>~/.pyric/serve-cache</code>.</td></tr><tr><td><code>--bridge</code></td><td>off</td><td>Also mount the MCP bridge on the dev-server origin (<code>/__pyric/mcp</code>). <code>--project</code> labels health/audit.</td></tr><tr><td><code>--ui</code></td><td>off</td><td>Serve Pyric Studio at <code>/__pyric/ui/</code> and open it instead of the app. Implies <code>--bridge</code>.</td></tr><tr><td><code>--project &#x3C;id></code></td><td>none</td><td>Project label exposed by the mounted bridge.</td></tr><tr><td><code>--allowed-host &#x3C;h,…></code></td><td>none</td><td>Extra <code>Host</code> headers to accept past the DNS-rebinding guard (<code>localhost</code>/<code>127.0.0.1</code> always allowed).</td></tr><tr><td><code>--only hosting</code></td><td>none</td><td>Accepted for firebase-serve parity (hosting is all v1 serves).</td></tr><tr><td><code>--no-run</code></td><td>off</td><td>Do not run the project’s <code>dev</code> script; host only.</td></tr><tr><td><code>--json</code></td><td>off</td><td>One machine line on stdout (<code>{url, port, mcpUrl, rulesHash, persist, restoredDocs, restoredUsers}</code>); banner → stderr. Readiness probe: <code>GET &#x3C;url>/__pyric/init.json</code> → 200.</td></tr></tbody></table></div>
+<p>Append <code>-- &#x3C;command></code> to run an explicit child process after the host starts.
+Without an explicit command, <code>pyric dev</code> runs the package’s <code>dev</code> script when
+one exists. The child receives the activated package-resolution environment;
+see <a href="../pyric-cli-reference-package-and-resolution/">package exports and resolution</a>.</p>
+<p>When <code>firebase.json</code> declares one Functions source, <code>pyric dev</code> also reads that
+source package’s <code>main</code> field (<code>index.js</code> by default) and starts an isolated
+Node child for supported <code>firebase-functions/v2/database.onValueCreated</code>
+exports. A Functions source implies the local bridge even without <code>--bridge</code>.
+<code>--no-run</code> suppresses only the project’s <code>dev</code> script; it does not suppress the
+declared Functions source. Unsupported trigger exports are reported and left
+inactive. See <a href="../pyric-cli-how-to-run-rtdb-onvaluecreated/">run an RTDB <code>onValueCreated</code> function locally</a>.
+The entry selected by <code>main</code> must be CommonJS; native ESM Functions entries are
+outside this first slice.</p>
+<p>Persistence, multi-tab, and SharedWorker behaviour are covered in
+<a href="../pyric-cli-how-to-serve-persistence-and-multi-tab/">persistence and multi-tab</a>.</p>
+<h3 id="pyric-init-dir-flags"><code>pyric init [dir] [flags]</code></h3>
+<p>Scaffold a pyric project. Never prompts; rerunning is safe (idempotent).</p>
+<div class="table-scroll">
+<table><thead><tr><th>Flag</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>--template &#x3C;web|static|node></code></td><td><code>web</code></td><td><code>web</code>: a Vite app using canonical <code>firebase/*</code> imports. <code>static</code>: a no-bundler app served by <code>pyric dev</code>. <code>node</code>: a script-style scaffold whose canonical Firebase imports are swapped when run through <code>pyric dev</code>.</td></tr><tr><td><code>--name &#x3C;name></code></td><td>dir name</td><td>Project name.</td></tr><tr><td><code>--force</code></td><td>off</td><td>Overwrite scaffold-owned files.</td></tr><tr><td><code>--json</code></td><td>off</td><td>Machine result on stdout: <code>{template, dir, created, merged, skipped, conflicts, nextSteps}</code>.</td></tr></tbody></table></div>
+<h3 id="pyric-vendor-dir---json"><code>pyric vendor [dir] [--json]</code></h3>
+<p>Retrofit the standalone-binary package tarballs into an existing project and
+merge their dependencies into <code>package.json</code>. This command is available in the
+standalone binary; registry installs normally use <code>npm install -D @pyric/cli</code>.</p>
+<p><a id="pyric-snapshot"></a></p>
+<h3 id="pyric-snapshot-flags"><code>pyric snapshot [flags]</code></h3>
+<p>Promote lived sandbox state (a live <code>dev --persist</code>, else
+<code>.pyric/state/state.json</code>) to a committable fixture that <code>pyric dev --seed &#x3C;file></code>
+re-serves (docs + auth users).</p>
+<div class="table-scroll">
+<table><thead><tr><th>Flag</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>--out &#x3C;file></code></td><td>none</td><td>Output path for the fixture.</td></tr><tr><td><code>--port &#x3C;n></code></td><td>none</td><td>Port of the live <code>pyric dev</code> to read from.</td></tr><tr><td><code>--force</code></td><td>off</td><td>Overwrite an existing output file.</td></tr><tr><td><code>--include-passwords</code></td><td>redacted</td><td>Keep auth-user passwords in the fixture (default: redacted). Trusted/local fixtures only.</td></tr><tr><td><code>--json</code></td><td>off</td><td>Machine output on stdout.</td></tr></tbody></table></div>
+<p>See <a href="../pyric-cli-how-to-promote-sandbox-state-to-a-fixture/">promote sandbox state to a fixture</a>.</p>
+<p><a id="pyric-verify"></a></p>
+<h3 id="pyric-verify-fixturedir-flags"><code>pyric verify [fixture|dir] [flags]</code></h3>
+<p>Replay a captured sandbox session against candidate rules. Captures can contain
+Firestore and Realtime Database services; <code>verify</code> checks the verifiable
+services present in the fixture unless <code>--service</code> filters them. With no
+positional argument it replays the latest <code>pyric dev</code> capture at
+<code>.pyric/last-session.json</code>.</p>
+<div class="table-scroll">
+<table><thead><tr><th>Flag</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>--service &#x3C;firestore|rtdb></code></td><td>all services in fixture</td><td>Verify one service. Repeat to verify several selected services.</td></tr><tr><td><code>--engine &#x3C;sandbox|rules-test-api|both></code></td><td><code>sandbox</code></td><td>Choose the verification engine. <code>rules-test-api</code> and <code>both</code> require <code>--project</code> (or <code>.firebaserc</code>) plus service-account / ADC credentials. Rules Test API verification is Firestore-only.</td></tr><tr><td><code>--rules &#x3C;service=path></code></td><td>from <code>firebase.json</code></td><td>Candidate rules to verify against. Repeat for mixed-service captures. Firestore rules are source files; RTDB rules are JSON files.</td></tr><tr><td><code>--json</code></td><td>off</td><td>Machine output on stdout.</td></tr></tbody></table></div>
+<p>Default candidate rules come from <code>firebase.json.firestore.rules</code> and
+<code>firebase.json.database.rules</code>. Captured rules are informational and are not
+used as the candidate ruleset.</p>
+<p><strong>Exit code:</strong> <code>1</code> on any failing divergence, <code>0</code> otherwise. Missing fixture or
+missing candidate rules exits <code>2</code>. Firestore auto-id aliases, time drift, and
+sentinel drift are informational and do not fail.</p>
+<p>Examples:</p>
+<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="sh"><code><span class="line"><span style="color:#61AFEF">pyric</span><span style="color:#98C379"> verify</span></span>
+<span class="line"><span style="color:#61AFEF">pyric</span><span style="color:#98C379"> verify</span><span style="color:#98C379"> journeys/</span><span style="color:#D19A66"> --rules</span><span style="color:#98C379"> firestore=firestore.rules</span></span>
+<span class="line"><span style="color:#61AFEF">pyric</span><span style="color:#98C379"> verify</span><span style="color:#98C379"> journeys/checkout.json</span><span style="color:#D19A66"> --engine</span><span style="color:#98C379"> rules-test-api</span><span style="color:#D19A66"> --project</span><span style="color:#98C379"> demo-app</span></span>
+<span class="line"><span style="color:#61AFEF">pyric</span><span style="color:#98C379"> verify</span><span style="color:#98C379"> journeys/checkout.json</span><span style="color:#D19A66"> --engine</span><span style="color:#98C379"> both</span><span style="color:#D19A66"> --project</span><span style="color:#98C379"> demo-app</span></span>
+<span class="line"><span style="color:#61AFEF">pyric</span><span style="color:#98C379"> verify</span><span style="color:#D19A66"> --service</span><span style="color:#98C379"> rtdb</span><span style="color:#D19A66"> --rules</span><span style="color:#98C379"> rtdb=database.rules.json</span></span>
+<span class="line"><span style="color:#61AFEF">pyric</span><span style="color:#98C379"> verify</span><span style="color:#D19A66"> --rules</span><span style="color:#98C379"> firestore=firestore.rules</span><span style="color:#D19A66"> --rules</span><span style="color:#98C379"> rtdb=database.rules.json</span></span></code></pre>
+<p>See <a href="../pyric-cli-how-to-verify-against-a-captured-session/">verify against a captured session</a>.</p>
+<h3 id="pyric-verify-cases-fixture-flags"><code>pyric verify cases [fixture] [flags]</code></h3>
+<p>Derive Firestore Rules Test API cases from a captured fixture without running
+verification.</p>
+<div class="table-scroll">
+<table><thead><tr><th>Flag</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>--service firestore</code></td><td><code>firestore</code></td><td>The service to derive cases for. Only Firestore is supported.</td></tr><tr><td><code>--out &#x3C;path></code></td><td>stdout</td><td>Write the derived case JSON to a file.</td></tr></tbody></table></div>
+<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="sh"><code><span class="line"><span style="color:#61AFEF">pyric</span><span style="color:#98C379"> verify</span><span style="color:#98C379"> cases</span><span style="color:#98C379"> journeys/checkout.json</span><span style="color:#D19A66"> --service</span><span style="color:#98C379"> firestore</span><span style="color:#D19A66"> --out</span><span style="color:#98C379"> journeys/checkout.cases.json</span></span></code></pre>
+<h3 id="pyric-mcp"><code>pyric mcp</code></h3>
+<p>Start a stdio MCP server for editors. It attaches to a running <code>pyric dev --bridge</code>, discovered through <code>.pyric/serve.json</code>, or hosts a persistent
+headless sandbox when no development server is available. See
+<a href="../pyric-cli-tutorials-wire-claude-code/">wire Claude Code</a>.</p>
+<h3 id="pyric-bridge-flags"><code>pyric bridge [flags]</code></h3>
+<p>Stand up the HTTP+WebSocket bridge external MCP clients connect to. It relays
+tool calls to a connected in-browser sandbox. See <a href="../pyric-cli-bridge/">bridge</a>.</p>
+<div class="table-scroll">
+<table><thead><tr><th>Flag</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>--port &#x3C;n></code></td><td><code>5174</code></td><td>Port to bind on <code>127.0.0.1</code>. Env: <code>PYRIC_PORT</code>.</td></tr><tr><td><code>--project &#x3C;id></code></td><td>none</td><td>Project id surfaced in <code>/health</code> + audit log. Env: <code>PYRIC_PROJECT</code>.</td></tr></tbody></table></div>
+<hr>
+<h2 id="service-first-artifact-commands">Service-first artifact commands</h2>
+<p>Every service command follows <code>pyric &#x3C;service> &#x3C;artifact> &#x3C;operation></code>. The
+Firestore rules commands wrap the rules toolchain documented in
+<a href="../pyric-rules/"><code>pyric/docs/rules/</code></a>.</p>
+<h3 id="pyric-firestore-rules-lint-path"><code>pyric firestore rules lint &#x3C;path></code></h3>
+<p>Run the Firestore rules linter against a file.</p>
+<h3 id="pyric-firestore-rules-validate-path"><code>pyric firestore rules validate &#x3C;path></code></h3>
+<p>Validate Firestore rules structure against a file.</p>
+<h3 id="pyric-firestore-rules-simulate---stdin"><code>pyric firestore rules simulate [--stdin]</code></h3>
+<p>Local rules simulator.</p>
+<div class="table-scroll">
+<table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>--stdin</code></td><td>Read a scripted simulation from stdin instead of running the interactive smoke-test.</td></tr></tbody></table></div>
+<h3 id="pyric-firestore-rules-resolve-path---out-path"><code>pyric firestore rules resolve &#x3C;path> [--out &#x3C;path>]</code></h3>
+<p>Resolve a Firestore <code>2+modules</code> source and write ordinary Firebase rules to
+stdout or <code>--out</code>.</p>
+<h3 id="pyric-firestore-indexes-generate-path---out-path"><code>pyric firestore indexes generate &#x3C;path...> [--out &#x3C;path>]</code></h3>
+<p>Derive composite-index definitions from application source. The default output
+is <code>firestore.indexes.json</code>.</p>
+<h3 id="pyric-storage-rules-lint-path"><code>pyric storage rules lint &#x3C;path></code></h3>
+<p>Check Storage rules syntax locally.</p>
+<h3 id="pyric-storage-rules-simulate---stdin"><code>pyric storage rules simulate [--stdin]</code></h3>
+<p>Run the local Storage rules evaluator.</p>
+<h3 id="pyric-database-rules-lint-path"><code>pyric database rules lint &#x3C;path></code></h3>
+<p>Run the Realtime Database rules JSON expression linter against a file.</p>
+<h3 id="pyric-database-rules-validate-path"><code>pyric database rules validate &#x3C;path></code></h3>
+<p>Validate Realtime Database rules JSON expressions against the local parser and
+expression validator.</p>
+<h3 id="pyric-database-rules-simulate---stdin"><code>pyric database rules simulate [--stdin]</code></h3>
+<p>Local Realtime Database rules simulator. With no flags, reads
+<code>firebase.json.database.rules</code> and runs a sample anonymous read. With <code>--stdin</code>,
+reads a JSON payload with <code>rulesJson</code> or <code>rulesPath</code>, <code>operation</code>, <code>path</code>,
+optional <code>auth</code>, <code>mockData</code>, and <code>newData</code>.</p>
+<h3 id="pyric-database-rules-generate---config-path---out-path"><code>pyric database rules generate [--config &#x3C;path>] [--out &#x3C;path>]</code></h3>
+<p>Load a constraints module (default <code>database.rules.ts</code>), compile it to Firebase
+RTDB rules JSON, and write the file. Does not contact a Firebase project.</p>  </article> </main> <aside class="doc-toc" aria-label="On this page"> <h2 class="doc-toc-heading">On this page</h2> <ul> <li data-depth="2"> <a href="#conventions">Conventions</a> </li><li data-depth="2"> <a href="#environment-variables">Environment variables</a> </li><li data-depth="2"> <a href="#local-development">Local development</a> </li><li data-depth="3"> <a href="#pyric-dev-flags">pyric dev [flags]</a> </li><li data-depth="3"> <a href="#pyric-init-dir-flags">pyric init [dir] [flags]</a> </li><li data-depth="3"> <a href="#pyric-vendor-dir---json">pyric vendor [dir] [--json]</a> </li><li data-depth="3"> <a href="#pyric-snapshot-flags">pyric snapshot [flags]</a> </li><li data-depth="3"> <a href="#pyric-verify-fixturedir-flags">pyric verify [fixture|dir] [flags]</a> </li><li data-depth="3"> <a href="#pyric-verify-cases-fixture-flags">pyric verify cases [fixture] [flags]</a> </li><li data-depth="3"> <a href="#pyric-mcp">pyric mcp</a> </li><li data-depth="3"> <a href="#pyric-bridge-flags">pyric bridge [flags]</a> </li><li data-depth="2"> <a href="#service-first-artifact-commands">Service-first artifact commands</a> </li><li data-depth="3"> <a href="#pyric-firestore-rules-lint-path">pyric firestore rules lint &lt;path&gt;</a> </li><li data-depth="3"> <a href="#pyric-firestore-rules-validate-path">pyric firestore rules validate &lt;path&gt;</a> </li><li data-depth="3"> <a href="#pyric-firestore-rules-simulate---stdin">pyric firestore rules simulate [--stdin]</a> </li><li data-depth="3"> <a href="#pyric-firestore-rules-resolve-path---out-path">pyric firestore rules resolve &lt;path&gt; [--out &lt;path&gt;]</a> </li><li data-depth="3"> <a href="#pyric-firestore-indexes-generate-path---out-path">pyric firestore indexes generate &lt;path...&gt; [--out &lt;path&gt;]</a> </li><li data-depth="3"> <a href="#pyric-storage-rules-lint-path">pyric storage rules lint &lt;path&gt;</a> </li><li data-depth="3"> <a href="#pyric-storage-rules-simulate---stdin">pyric storage rules simulate [--stdin]</a> </li><li data-depth="3"> <a href="#pyric-database-rules-lint-path">pyric database rules lint &lt;path&gt;</a> </li><li data-depth="3"> <a href="#pyric-database-rules-validate-path">pyric database rules validate &lt;path&gt;</a> </li><li data-depth="3"> <a href="#pyric-database-rules-simulate---stdin">pyric database rules simulate [--stdin]</a> </li><li data-depth="3"> <a href="#pyric-database-rules-generate---config-path---out-path">pyric database rules generate [--config &lt;path&gt;] [--out &lt;path&gt;]</a> </li> </ul> </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>