Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/lvndry/jazz/llms.txt

Use this file to discover all available pages before exploring further.

Workflow commands let you automate recurring tasks with AI agents.

​
jazz workflow list

List all available workflows. 
jazz workflow list
jazz workflow ls  # alias
Displays workflows organized by location:
  • Local workflows: Project-specific workflows in ./workflows/
  • Global workflows: User workflows in ~/.jazz/workflows/
  • Built-in workflows: Workflows that ship with Jazz
For each workflow, shows:
  • Name and description
  • Schedule (if configured)
  • Agent assignment
  • Scheduling status (scheduled, running, not scheduled)

​
jazz workflow show

View detailed information about a workflow. 
jazz workflow show <name>
Arguments:
​
name
string
required
Workflow name to display
Displays:
  • Full workflow configuration (YAML frontmatter)
  • Workflow instructions (Markdown content)
  • File location
  • Schedule description (if configured)

​
jazz workflow run

Run a workflow immediately. 
jazz workflow run <name> [options]
Arguments:
​
name
string
required
Workflow name to run
Options:
​
--auto-approve
boolean
Automatically approve tool executions based on workflow’s auto-approve policy
​
--agent
string
Agent ID or name to use for this run (overrides workflow configuration)
​
--scheduled
boolean
Internal flag indicating this run was triggered by the scheduler

​
Examples

# Run a workflow interactively (you approve each action)
jazz workflow run email-cleanup

# Run with auto-approve (workflow policy applies)
jazz workflow run email-cleanup --auto-approve

# Run with a specific agent
jazz workflow run tech-digest --agent my-researcher
Use --auto-approve carefully. Ensure your workflow’s auto-approve policy matches the risk level of its operations.

​
jazz workflow schedule

Enable scheduled execution for a workflow. 
jazz workflow schedule <name>
Arguments:
​
name
string
required
Workflow name to schedule
Registers the workflow with your system scheduler:
  • macOS: Creates a launchd plist in ~/Library/LaunchAgents/
  • Linux: Creates a cron entry
The workflow will run according to its schedule field (cron expression).
The workflow must have a schedule field in its YAML frontmatter.

​
Example

jazz workflow schedule email-cleanup
# ✓ Scheduled workflow: email-cleanup
# Will run: Every hour
# Next run: 2024-03-03 15:00:00

​
jazz workflow unschedule

Disable scheduled execution for a workflow. 
jazz workflow unschedule <name>
Arguments:
​
name
string
required
Workflow name to unschedule
Removes the workflow from the system scheduler. The workflow can still be run manually.

​
jazz workflow scheduled

List all workflows that are currently scheduled. 
jazz workflow scheduled
Shows:
  • Workflow name
  • Cron schedule
  • Human-readable schedule description
  • Next scheduled run time

​
jazz workflow catchup

Run workflows that missed their scheduled execution. 
jazz workflow catchup
This command:
  1. Identifies workflows that should have run while your machine was off
  2. Lets you select which ones to run now
  3. Executes them with their configured auto-approve policy
Jazz can automatically run catch-up workflows on startup if catchUpOnStartup: true is set in the workflow configuration.

​
jazz workflow history

View workflow execution history. 
jazz workflow history [name]
Arguments:
​
name
string
Optional workflow name to filter history
Shows recent workflow runs with:
  • Workflow name
  • Start and end times
  • Status (success, failed, running)
  • Agent used
  • Trigger (manual, scheduled, catch-up)

​
Examples

# View all workflow history
jazz workflow history

# View history for a specific workflow
jazz workflow history email-cleanup

​
Built-in workflows

Jazz ships with several ready-to-use workflows:
Schedule: HourlyArchives newsletters, organizes promotional emails, and flags important messages.
jazz workflow run email-cleanup
jazz workflow schedule email-cleanup
Schedule: Daily at 9 AMScans AI/tech news sources and compiles a personalized digest.
jazz workflow run tech-digest
Schedule: Every morning at 7 AMProvides weather forecast and outfit recommendations.
jazz workflow run weather-briefing
Schedule: DailyStock and crypto analysis with buy/sell signals.
jazz workflow run market-analysis

​
Tips

Start workflows with autoApprove: read-only and gradually increase to low-risk or high-risk as you build confidence.
Test workflows with jazz workflow run before scheduling them.
Check workflow history regularly to ensure scheduled runs are completing successfully.

​
Next steps

Workflow guide

Learn how to create custom workflows

Workflow structure

YAML frontmatter and configuration reference

Build docs developers (and LLMs) love

Get started for freeTalk to us