workflows-starter-app

Copier template for bootstrapping Mistral Workflows projects.

Usage

This template is used by the mistralai-workflows-cli CLI:

uvx mistralai-workflows-cli setup

Or directly with copier:

copier copy gh:mistralai/workflows-starter-app my-project

Template Structure

template/
├── .env.jinja                          # MISTRAL_API_KEY injection
├── .gitignore
├── pyproject.toml.jinja                # Project config with SDK dependency
├── README.md.jinja
├── Makefile                            # start-worker & execute commands
├── .agents/skills/workflows/SKILL.md   # Vibe skill for creating workflows
└── src/
    ├── discover.py             # Auto-discovers workflow classes & starts worker
    └── workflows/
        ├── __init__.py
        ├── hello.py                     # Minimal example workflow
        └── start.py                    # CLI to execute a workflow by name

Auto-Discovery

Workflows are auto-discovered at worker startup. Any class decorated with @workflows.workflow.define in src/workflows/ is automatically registered — no manual imports needed. Just add a new file and restart the worker.

Variables

Variable	Description
project_name	Name of the project (used in pyproject.toml, workflow names)
mistral_api_key	Mistral API key (written to .env, excluded from git)