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.

Configuration commands let you view and modify Jazz’s global and project-specific settings.

​
jazz config show

Display all configuration values. 
jazz config show
Shows the complete merged configuration including:
  • Global settings from ~/.jazz/jazz.config.json
  • Project settings from ./jazz.config.json
  • Environment variable overrides
Configuration is displayed in a formatted, hierarchical view.

​
jazz config get

Retrieve a specific configuration value. 
jazz config get <key>
Arguments:
​
key
string
required
Configuration key in dot notation (e.g., llm.defaultProvider)

​
Examples

# Get the default LLM provider
jazz config get llm.defaultProvider

# Get verbose logging setting
jazz config get logging.verbose

# Get MCP server configuration
jazz config get mcpServers.github

​
jazz config set

Set a configuration value. 
jazz config set <key> [value]
Arguments:
​
key
string
required
Configuration key in dot notation
​
value
string
Value to set (if omitted, opens an interactive editor)

​
Examples

# Set default LLM provider
jazz config set llm.defaultProvider openai

# Enable verbose logging
jazz config set logging.verbose true

# Set API key (interactive)
jazz config set llm.providers.openai.apiKey
Boolean values can be set as true/false, numbers as plain digits, and strings as plain text.

​
Configuration structure

Jazz configuration is organized into these sections:

​
LLM providers

{
  "llm": {
    "defaultProvider": "openai",
    "providers": {
      "openai": {
        "apiKey": "sk-...",
        "defaultModel": "gpt-4o-2024-08-06"
      },
      "anthropic": {
        "apiKey": "sk-ant-...",
        "defaultModel": "claude-3-5-sonnet-20241022"
      }
    }
  }
}

​
MCP servers

{
  "mcpServers": {
    "github": {
      "enabled": true
    },
    "notion": {
      "enabled": false
    }
  }
}

​
Logging

{
  "logging": {
    "level": "info",
    "verbose": false,
    "file": "~/.jazz/logs/jazz.log"
  }
}

​
Storage

{
  "storage": {
    "agentsPath": "~/.jazz/agents",
    "workflowsPath": "~/.jazz/workflows",
    "skillsPath": "~/.jazz/skills"
  }
}

​
Configuration file locations

Jazz merges configuration from multiple locations (in order of precedence):
  1. Environment variables (highest priority)
    • OPENAI_API_KEY, ANTHROPIC_API_KEY, etc.
    • JAZZ_CONFIG_PATH - Override config file location
  2. Project configuration
    • ./jazz.config.json in current directory
    • Overrides global settings for this project
  3. Global configuration (lowest priority)
    • ~/.jazz/jazz.config.json
    • Default settings for all Jazz usage

​
Configuration wizard

For first-time setup, Jazz provides an interactive configuration wizard: 
jazz
The wizard will:
  1. Detect which LLM providers you have API keys for
  2. Help you configure your preferred provider
  3. Test the connection
  4. Save the configuration

​
Examples

​
View all configuration

jazz config show

​
Get OpenAI model

jazz config get llm.providers.openai.defaultModel
# Output: gpt-4o-2024-08-06

​
Set Anthropic API key

jazz config set llm.providers.anthropic.apiKey sk-ant-your-key

​
Check verbose logging

jazz config get logging.verbose
# Output: false

​
Tips

Use project-specific ./jazz.config.json files to override settings for different projects or teams.
Store API keys in environment variables for better security, especially in shared environments.
Never commit jazz.config.json files with API keys to version control. Add them to .gitignore.

​
Next steps

Configuration guide

Learn about advanced configuration options

LLM providers

Configure different LLM providers

Build docs developers (and LLMs) love

Get started for freeTalk to us