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.

The Evidence CLI lets you run and develop Evidence projects locally from the command line. If you are going to use the CLI for development, you should set up the GitHub Integration. It includes a development server for previewing your reports locally as you work, commands for running queries, viewing metadata, and validating your code.
The Evidence CLI is in alpha. Features and commands may change.

​
Install

curl -fsSL https://gaamozau3jchzs3r.public.blob.vercel-storage.com/cli/install.sh | sh
This downloads the correct binary for your platform and installs it to /usr/local/bin. If that directory is not writable, it falls back to ~/.local/bin. Both evidence and evd commands are available after install.

​
Supported Platforms

  • macOS arm64 (Apple Silicon)
  • macOS x64 (Intel)
  • Linux x64

​
Verify Installation

evidence version

​
Getting Started

  1. Create a project in Evidence Studio and connect it to a GitHub repo.
  2. Clone the repo to your local machine.
  3. Log in to your Evidence account via the CLI: 
    evidence login
  4. Start developing from inside your cloned project directory: 
    evidence dev
  5. Open a pull request on the repo. Evidence Studio will reply with a preview link. Merging the PR releases your changes.

​
Upgrade

evidence upgrade
The CLI checks for updates on startup. If a newer version is available, you’ll see a warning. If your version is below the minimum supported version, the CLI will require an upgrade before running.