Skip to main content

CLI Reference

Commands

CommandDescription
npm run devStart the development server in the current directory.
npm run buildBuild the project for production.
npm run build:strictBuild, but fails on query or component errors.
rRestart the dev server (when running).

You can stop the server with Ctrl + C / + C.

Options

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.

Evidence runs a Vite server, and so supports Vite's options.

Some of the most common are:

FlagDescriptionDetail
--open [path]Open browser to path on startup (string)Default --open / opens in root of the project.
--host [host]Specify hostname (string)--host 0.0.0.0 can be helpful in containers
--port <port>Specify port (number)Automatically increment if default 3000 is in use.

Environment Variables

You can set environment variables to configure Evidence in both development and production.

Evidence does not currently support a .env file, but you can set environment variables in your terminal before running the command.

All Redshift environment variables are set using the PostgreSQL variables.

VariableDescriptionOptions (if applicable)
EVIDENCE_DATABASEThe database to use.bigquery , snowflake , redshift, postgres, trino, mssql, mysql, sqlite, duckdb, csv
EVIDENCE_BIGQUERY_PROJECT_IDBigQuery Project ID
EVIDENCE_BIGQUERY_CLIENT_EMAILBigQuery Client Email
EVIDENCE_BIGQUERY_PRIVATE_KEYBigQuery Private Key
EVIDENCE_BIGQUERY_AUTHENTICATORBigQuery Authenticatoroauth, gcloud-cli, service-account
EVIDENCE_BIGQUERY_TOKENBigQuery OAuth Token
EVIDENCE_SNOWFLAKE_ACCOUNTSnowflake Account ID
EVIDENCE_SNOWFLAKE_USERNAMESnowflake Username
EVIDENCE_SNOWFLAKE_PASSWORDSnowflake Password
EVIDENCE_SNOWFLAKE_DATABASESnowflake Database
EVIDENCE_SNOWFLAKE_WAREHOUSESnowflake Warehouse
EVIDENCE_SNOWFLAKE_ROLESnowflake Role
EVIDENCE_SNOWFLAKE_SCHEMASnowflake Schema
EVIDENCE_SNOWFLAKE_AUTHENTICATORSnowflake Authenticatorsnowflake_jwt, externalbrowser, okta, snowflake
EVIDENCE_SNOWFLAKE_PRIVATE_KEYSnowflake Private Key
EVIDENCE_SNOWFLAKE_PASSPHRASESnowflake Passphrase
EVIDENCE_SNOWFLAKE_OKTA_URLSnowflake Okta URL
EVIDENCE_POSTGRES_USERPostgres Username
EVIDENCE_POSTGRES_HOSTPostgres Host
EVIDENCE_POSTGRES_DATABASEPostgres Database
EVIDENCE_POSTGRES_PASSWORDPostgres Password
EVIDENCE_POSTGRES_PORTPostgres Port
EVIDENCE_POSTGRES_SCHEMAPostgres Schema
EVIDENCE_POSTGRES_SSLPostgres SSLtrue , false, no-verify
EVIDENCE_POSTGRES_CONNECTIONSTRINGPostgres Connection String
EVIDENCE_TRINO_HOSTTrino Host
EVIDENCE_TRINO_SSLTrino SSL
EVIDENCE_TRINO_PORTTrino Port
EVIDENCE_TRINO_USERTrino User
EVIDENCE_TRINO_PASSWORDTrino Password
EVIDENCE_TRINO_CATALOGTrino Catalog
EVIDENCE_TRINO_SCHEMATrino Schema
EVIDENCE_MYSQL_USERMySQL Username
EVIDENCE_MYSQL_HOSTMySQL Host
EVIDENCE_MYSQL_DATABASEMySQL Database
EVIDENCE_MYSQL_PASSWORDMySQL Password
EVIDENCE_MYSQL_PORTMySQL Port
EVIDENCE_MYSQL_SOCKETPATHMySQL Socket Path
EVIDENCE_MYSQL_SSLMySQL SSLtrue , false, no-verify
EVIDENCE_SQLITE_FILENAMESQLite Filename
EVIDENCE_DUCKDB_FILENAMEDuckDB Filename
SEND_ANONYMOUS_USAGE_STATSSend anonymous usage statsyes , no