Install Evidence
The easiest way to get started with Evidence is to use the VSCode Extension.
VSCode Extension
- Install Evidence from the VSCode Marketplace
- Open the Command Palette (
Ctrl/Cmd + Shift + P
) and enterEvidence: New Evidence Project
- Click
Start Evidence
in the bottom status bar
The template project running in your browser contains a tutorial on how to use Evidence.
Install VSCode ExtensionOther Options
- Command Line
- With dbt
- Codespaces
- Docker
npx degit evidence-dev/template my-project
cd my-project
npm install
npm run dev
cd path/to/your/dbt/project
npx degit evidence-dev/template reports
npm --prefix ./reports install
npm --prefix ./reports run dev
You can install Evidence inside your dbt project, inside a folder called reports
, to create a monorepo.
This allows changes across your modelling layer (in /models
) and your reporting layer (in reports
) in the same commits.
This currently needs to be done from the terminal, rather than from the dbt Cloud UI.
Create Evidence Codespace
Note: Codespaces is much faster on the Desktop app. After the Codespace has booted, select the hamburger menu → Open in VS Code Desktop.
Evidence provides a development Docker image.
See our Docker Development Environment repository for instructions.