CLI Reference


CLI VS Code Description
npx degit evidence-dev/template my-project Evidence: New Evidence Project Create a new project from the template
npm run sources Evidence: Run Sources Extract data from sources
npm run dev Evidence: Start Server Start the development server in the current directory
npm run build Evidence: Build Build the project for production
npm run build:strict Evidence: Built Strict Build, but fails on query or component errors
npm run preview N/A Preview the built site
Ctrl / Cmd + C Evidence: Stop Server Stop the dev server (when running)
r N/A Restart the dev server (when running)
No Results


Append flags with an extra -- after the command to modify behavior.

For example, npm run dev -- --port 4000 will start the development server on port 4000.

Some of the most common are:

Command Flag Description Detail
sources --changed Run sources whose queries have changed null
sources --sources [source_name] Run sources from the specified sources Seperate with commas --sources source1,source2
sources --queries [query_name] Run the specified queries Seperate with commas
sources --debug Show debug output null
dev --open [path] Open browser to <code>path</code> on startup Default --open / opens in root of the project
dev --host [host] Specify hostname --host can be helpful in containers
dev --port Specify port Automatically increment if default 3000 is in use
No Results

Evidence's dev and build commands run using Vite, and so support Vite's options.

Evidence's preview command runs using npx serve and supports Serve's options

Environment Variables

You can set environment variables to configure Evidence in production. Most of these are used to set database credentials securely.

The format of environment variables for database credentials is EVIDENCE_SOURCE__[source_name]__[variable_name].

You can copy all your current environment variable values from the settings page at localhost:3000/settings.

N.B. Environment variables are case sensitive, so you should preserve the case specified in the settings page.

.env Files

Evidence will read in environment variables from a .env file in the root of your project. This is useful for local development.