Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.evidence.studio/llms.txt

Use this file to discover all available pages before exploring further.

Development

evidence dev

Start the local development server.
evidence dev
evidence dev --port 8080
OptionDescription
--port, -pPort to run on (default: 3000)

Data

evidence query

Run a SQL query against connected data sources.
evidence query "SELECT * FROM orders LIMIT 10"
evidence query --file query.sql
cat query.sql | evidence query -
OptionDescription
--formatOutput format: json (default), jsonl, table, csv
--limit, -lLimit number of rows
--quiet, -qSuppress status messages
--columnsOutput only column names and types
--fileRead SQL from a file
--output, -oWrite results to a file

evidence tables

List available data tables.
evidence tables

evidence describe

Show schema for a table.
evidence describe demo_daily_orders

evidence schema

Show all tables with their columns.
evidence schema

evidence connectors

List all connectors with health status.
evidence connectors
evidence connectors --json
Shows connector name, type, status, last sync, schedule, table count, and reference count for all connector types.

evidence models

List all models with refresh status.
evidence models
evidence models --json
Shows model name, status, last refresh time, and schedule.

evidence lineage

Show where connections and tables are used across projects, pages, models, and queries.
evidence lineage
evidence lineage table orders
evidence lineage --branch dev/alex
evidence lineage --json
OptionDescription
table <name>Show where a specific table is referenced
--branchQuery a specific branch (default: main)
--jsonOutput JSON for tooling

Project

evidence validate

Validate all markdown files in the current project.
evidence validate
evidence validate --json

evidence docs

Browse and search component documentation.
evidence docs                         # Overview
evidence docs search "chart"          # Search docs
evidence docs component bar_chart     # Component details

Authentication

evidence login

Authenticate with Evidence Studio using your browser.
evidence login

evidence logout

Clear stored credentials.
evidence logout

evidence whoami

Show the currently authenticated user.
evidence whoami

evidence orgs

List available organizations.
evidence orgs

evidence switch

Switch to a different organization.
evidence switch "My Organization"

Utility

evidence version

Print the current CLI version.
evidence version

evidence upgrade

Upgrade to the latest CLI version.
evidence upgrade

evidence help

Show help and available commands.
evidence help