Evidence Project

This is an Evidence Studio project — interactive data reports written in Markdown with embedded Markdoc components, backed by SQL.

The latest version of Evidence has some key changes you may not be aware of (recent AI models aren't trained on the new syntax) — read these carefully:

1. The docs are now hosted at https://docs.evidence.studio
2. You run the Evidence CLI to start the dev server, validate syntax, retrieve docs etc. Run evidence help to see all commands.
3. The syntax has changed: a. Components are markdoc style {% table data="demo.daily_orders" /%} b. SQL now runs ClickHouse SQL, unless you are using a direct connector, in which case it runs native SQL for your warehouse
4. Sample data is available, run evidence tables to see it.

Install Evidence CLI

MacOS / Linux

curl -fsSL https://evidence.studio/install.sh | sh

Windows

irm https://evidence.studio/install.ps1 | iex

Using the CLI

• evidence help — discover all available commands
• evidence login — authenticate (the user may need to run this themselves, as it requires a browser verification code step)
• evidence dev — start the local dev server to view report pages; show the user the URL, or — better — open it in their browser
• evidence validate — check Markdown and component syntax

Example: Sample Data

# Orders by Month

{% dropdown data="demo.daily_orders" id="category" value_column="category" /%}

{% table
  data="demo.daily_orders"
  filters=["category"]
/%}

Example: Inline Data

```sql item_sales
select 223 as sales, 'Widgets' as product
union all
select 498 as sales, 'Gizmos' as product
union all
select 354 as sales, 'Thingys' as product
```

# Product Sales

{% bar_chart
  data="item_sales"
  x="product"
  y="sum(sales)"
  order="sum(sales) desc"
/%}

Credentials

Credentials for direct connectors live in connection.yaml in the project root. If connection.yaml is not specified the Evidence Warehouse will be used.