@bonnard/cli 0.1.12 → 0.1.13

package/dist/bin/bon.mjs

@@ -2659,6 +2659,15 @@ function getChildTopics(topicId) {
 function searchTopics(query) {
 	const results = [];
 	const queryLower = query.toLowerCase();
+	const index = loadIndex();
+	if (index) {
+		const indexMatches = [];
+		for (const line of index.split("\n")) if (line.toLowerCase().includes(queryLower)) indexMatches.push(line.trim());
+		if (indexMatches.length > 0) results.push({
+			topic: "(index)",
+			matches: indexMatches.slice(0, 3)
+		});
+	}
 	for (const topic of getAvailableTopics()) {
 		const content = loadTopic(topic);
 		if (!content) continue;

package/dist/docs/topics/getting-started.md

@@ -0,0 +1,157 @@
+# Getting Started
+
+> Set up Bonnard and build your first semantic layer in minutes.
+
+## What is Bonnard?
+
+Bonnard is a semantic layer platform that sits between your data warehouse and your consumers (BI tools, AI agents, applications). You define your metrics and dimensions once in YAML, then query them through a consistent API.
+
+## Prerequisites
+
+- **Node.js 18+** — [Install Node.js](https://nodejs.org)
+- **A data warehouse** — PostgreSQL, Snowflake, BigQuery, or Databricks (or use our demo dataset)
+- **A Bonnard account** — [Sign up at app.bonnard.dev](https://app.bonnard.dev)
+
+## Install the CLI
+
+```bash
+npm install -g @bonnard/cli
+```
+
+Verify the installation:
+
+```bash
+bon --version
+```
+
+## Log in
+
+Authenticate with your Bonnard account:
+
+```bash
+bon login
+```
+
+This opens your browser to complete authentication. Once done, verify with:
+
+```bash
+bon whoami
+```
+
+## Initialize a project
+
+Navigate to your project directory and run:
+
+```bash
+bon init
+```
+
+This creates the project structure:
+
+```
+my-project/
+├── bon.yaml              # Project configuration
+├── bonnard/
+│   ├── cubes/            # Cube definitions (measures + dimensions)
+│   └── views/            # View definitions (curated interfaces)
+└── .bon/                 # Local config (gitignored)
+    └── datasources.yaml
+```
+
+If you have an existing dbt project, `bon init` will detect it and set up your agent context accordingly.
+
+## Connect a data source
+
+Add your warehouse connection:
+
+```bash
+bon datasource add
+```
+
+Follow the interactive prompts to configure your connection. If you use dbt, you can import from your profiles:
+
+```bash
+bon datasource add --from-dbt
+```
+
+**No warehouse yet?** Use our demo dataset — a read-only retail database (Contoso) with sales, products, stores, and customer data:
+
+```bash
+bon datasource add --demo
+```
+
+Test the connection:
+
+```bash
+bon datasource test contoso_demo
+```
+
+## Create your first cube
+
+Create a file at `bonnard/cubes/sales.yaml` (using the demo dataset — adapt table and column names to your own data):
+
+```yaml
+cubes:
+  - name: sales
+    sql_table: contoso.fact_sales
+    data_source: contoso_demo
+
+    measures:
+      - name: count
+        type: count
+
+      - name: total_revenue
+        type: sum
+        sql: sales_amount
+
+    dimensions:
+      - name: sales_key
+        type: number
+        sql: sales_key
+        primary_key: true
+
+      - name: date
+        type: time
+        sql: date_key
+
+      - name: sales_quantity
+        type: number
+        sql: sales_quantity
+```
+
+## Validate
+
+Check your cubes and views for errors:
+
+```bash
+bon validate
+```
+
+## Deploy
+
+Push your semantic layer to Bonnard:
+
+```bash
+bon deploy
+```
+
+## Query
+
+Test your deployed semantic layer:
+
+```bash
+bon query '{"measures": ["sales.count"]}'
+
+# With a dimension
+bon query '{"measures": ["sales.total_revenue"], "dimensions": ["sales.date"]}'
+
+# Or use SQL format
+bon query --sql "SELECT MEASURE(total_revenue) FROM sales"
+```
+
+## Next steps
+
+- Learn about [cubes](/docs/modeling/cubes) — measures, dimensions, joins
+- Learn about [views](/docs/modeling/views) — curated interfaces for consumers
+- Set up [MCP](/docs/workflow/mcp) — connect AI agents to your semantic layer
+- Read the full [workflow guide](/docs/workflow) — validate, deploy, query

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bonnard/cli",
-  "version": "0.1.12",
+  "version": "0.1.13",
   "type": "module",
   "bin": {
     "bon": "./dist/bin/bon.mjs"
@@ -9,7 +9,7 @@
     "dist"
   ],
   "scripts": {
-    "build": "tsdown src/bin/bon.ts --format esm --out-dir dist/bin && cp -r src/templates dist/ && mkdir -p dist/docs/topics dist/docs/schemas && cp ../content/index.md dist/docs/_index.md && cp ../content/modeling/*.md dist/docs/topics/",
+    "build": "tsdown src/bin/bon.ts --format esm --out-dir dist/bin && cp -r src/templates dist/ && mkdir -p dist/docs/topics dist/docs/schemas && cp ../content/index.md dist/docs/_index.md && cp ../content/getting-started.md dist/docs/topics/ && cp ../content/modeling/*.md dist/docs/topics/",
     "dev": "tsdown src/bin/bon.ts --format esm --out-dir dist/bin --watch",
     "test": "vitest run"
   },