Implementation:Evidentlyai Evidently CLI Demo Project

Knowledge Sources	Evidentlyai_Evidently
Domains	CLI, Demo Projects, Data Monitoring
Last Updated	2026-02-14 12:00 GMT

Overview

CLI command that generates demo projects in a local or remote Evidently workspace for experimentation and onboarding purposes.

Description

The generate_demo_project function is a Typer CLI command registered under the demo_project subcommand. It looks up a named demo project from the DEMO_PROJECTS registry and creates it in the specified workspace. The workspace can be either a local filesystem path or a remote HTTP endpoint. When a remote URL is provided, authentication is handled via a secret parameter or the EVIDENTLY_SECRET environment variable.

The function also supports deterministic UUID generation (controlled by the EXPERIMENTAL_DETERMINISTIC_UUID environment variable) for reproducible project creation, which is useful for testing and CI pipelines.

Usage

Use this command when you want to quickly bootstrap an Evidently workspace with sample data and pre-configured dashboards. This is especially helpful for new users exploring the Evidently UI or for creating reproducible demo environments.

Code Reference

Source Location

Repository: Evidentlyai_Evidently
File: src/evidently/cli/demo_project.py

Signature

@app.command("demo_project")
def generate_demo_project(
    project: str = Option("all", help="Project to generate"),
    path: str = Option("workspace", help="Workspace path or URL (if starts with http)"),
    secret: Optional[str] = Option(None, help="Secret for remote workspace authentication"),
):

Import

from evidently.cli.demo_project import generate_demo_project

I/O Contract

Inputs

Name	Type	Required	Description
project	str	No (default: "all")	Name of the demo project to generate; must be a valid key in DEMO_PROJECTS registry
path	str	No (default: "workspace")	Filesystem path or HTTP URL for the target workspace
secret	Optional[str]	No	Secret token for remote workspace authentication; falls back to EVIDENTLY_SECRET env var

Outputs

Name	Type	Description
(side effect)	None	Creates a demo project in the specified workspace; prints error and exits with code 1 if project name is not found

Usage Examples

# Generate all demo projects in a local workspace
evidently demo_project --project all --path ./my_workspace

# Generate a specific demo project to a remote workspace
evidently demo_project --project "adult" --path http://localhost:8000 --secret my_secret

# Programmatic usage
from evidently.cli.demo_project import generate_demo_project
generate_demo_project(project="all", path="workspace", secret=None)

Related Pages

Environment:Evidentlyai_Evidently_Python_Core_Environment
Evidentlyai_Evidently_CLI_Legacy_UI - Legacy UI command that also supports demo project generation

Page Connections

Double-click a node to navigate. Hold to expand connections.

Principle

Implementation

Heuristic

Environment