@balpal4495/quorum 1.0.0 → 3.0.0

package/.github/copilot-instructions.md

@@ -2,11 +2,14 @@
 
 ## Architecture
 
-This project uses three portable reasoning modules: **Oracle**, **Jury**, and **Council**.
-They form the knowledge and validation layer for all agentic work in this codebase.
+This project uses six portable reasoning modules: **Advisor**, **Oracle**, **Jury**, **Council**, **Sentinel**, and **Compass**.
+They form the knowledge, validation, and product-direction layer for all agentic work in this codebase.
 
 ```
-oracle.query()  →  jury.evaluate()  →  council.deliberate()  →  human gate  →  Executor
+Advisor  →  plain-language Chronicle queries
+Oracle   →  Jury  →  Council  →  human gate  →  Executor
+Sentinel →  coverage + drift
+Compass  →  product-direction synthesis (behaviours, pathways, bets, scoring)
 ```
 
 Source: `modules/` — see [modules/README.md](modules/README.md) for full API reference.
@@ -35,20 +38,23 @@ There are no auto-commits. Do not attempt to bypass this gate.
 
 | Module | What it does | LLM? |
 |---|---|---|
+| `ask()` | Plain-language question answered from Chronicle — validates internally, retries up to 2× | Yes |
 | `oracle.query()` | Retrieves relevant Chronicle entries by semantic + BM25 search | No |
 | `oracle.propose()` | Stages a new entry for human review | No |
 | `oracle.commit()` | Indexes an approved entry — human-triggered only | No |
 | `jury.evaluate()` | Scores a design against evidence across 4 dimensions | Yes |
 | `council.deliberate()` | Adversarial validation via advisor/reviewer fan-out | Yes |
+| `sentinel` | Coverage reporting, drift detection, and PR coverage maps | Optional |
+| `compass` | Product-direction synthesis — behaviours, opportunities, pathways, bets, idea scoring | Optional |
 
 ---
 
 ## Setup
 
 ```typescript
-import { setup } from "./modules/setup"
+import { setup } from "@balpal4495/quorum"
 
-const { oracle, evaluate, deliberate } = await setup({ llm: yourProvider })
+const { oracle, evaluate, deliberate, ask, compass } = await setup({ llm: yourProvider })
 ```
 
 `setup()` creates Chronicle directories, warms the embedder, and wires all dependencies.
@@ -87,8 +93,25 @@ After `council.deliberate()`:
 
 ---
 
+## CLI quick reference
+
+```bash
+quorum advisor brief                        # full Chronicle summary, no LLM
+quorum advisor query "topic"                # keyword search, no LLM
+quorum advisor "plain-language question"    # synthesised answer via LLM
+quorum check --outcome "..." --design "..."  # instant risk triage
+quorum commit --list                        # review pending proposals
+quorum commit <id>                          # approve a Chronicle entry
+quorum compass map                          # map current product behaviours (no LLM)
+quorum compass brief                        # product-direction summary (LLM)
+quorum compass pathways --goal "..."        # generate product pathways (LLM)
+quorum compass score "idea"                 # score a product idea (LLM)
+```
+
+---
+
 ## Build and test
 
 ```bash
-npx vitest run modules/
+npx vitest run modules/ evals/
 ```