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.

Jazz provides a comprehensive command-line interface for creating and managing autonomous AI agents. The CLI is organized into logical command groups for agents, workflows, MCP servers, and configuration.

Command structure

All Jazz commands follow this pattern:
jazz [command] [subcommand] [options]

Global options

These options work with all commands:
-v, --verbose
boolean
Enable verbose logging output
--debug
boolean
Enable debug level logging with detailed trace information
--config
string
Path to a custom configuration file (default: ~/.jazz/jazz.config.json)
--no-tui
boolean
Disable terminal UI and use plain terminal output (useful for CI/CD, scripts, or small terminals)
--output
string
Output mode: rendered, hybrid (default), raw (no formatting), or quiet (suppress output)

Command groups

Agent commands

Create, manage, and chat with AI agents

Persona commands

Create and manage agent personas

Workflow commands

Run and schedule automated workflows

MCP commands

Manage Model Context Protocol servers

Config commands

View and modify configuration settings

Auth commands

Authenticate with external services

In-chat commands

Slash commands available during agent conversations

Quick start

Run Jazz without arguments to launch the interactive wizard:
jazz
The wizard will help you:
  • Configure your first LLM provider
  • Create your first agent
  • Start chatting

Common workflows

Create and chat with an agent

# Create a new agent (interactive)
jazz agent create

# Chat with the agent
jazz agent chat my-agent

Run a workflow

# List available workflows
jazz workflow list

# Run a workflow once
jazz workflow run email-cleanup

# Schedule a workflow
jazz workflow schedule email-cleanup

Add an MCP server

# Add interactively
jazz mcp add

# Add from file
jazz mcp add --file mcp-config.json

Output modes

Jazz supports multiple output modes for different use cases:
  • rendered (default in TTY): Rich terminal UI with colors and formatting
  • hybrid: Mix of formatted and plain output
  • raw: Plain text output, ideal for piping or CI/CD
  • quiet: Suppress all output except errors
# Use raw output in CI/CD
jazz --output raw workflow run code-review --auto-approve

# Quiet mode for scripts
jazz --output quiet agent list

Environment variables

JAZZ_NO_TUI
string
Set to 1 to disable terminal UI (same as --no-tui)
JAZZ_OUTPUT_MODE
string
Set output mode: rendered, hybrid, raw, or quiet

Version and help

# Show version
jazz --version

# Show help for any command
jazz --help
jazz agent --help
jazz workflow run --help

Next steps

Agent commands

Learn about agent management

Workflow commands

Explore workflow automation