env.example

# =============================================================================
# cmdify - Environment Variables
# =============================================================================
# Copy this file and fill in your values:
#   cp env.example .env
#   source .env
#
# Configuration precedence: CLI flags > environment variables > config file > defaults
# Config file discovery: -c/--config CLI flag > CMDIFY_CONFIG env var >
#   $XDG_CONFIG_HOME/cmdify/config.toml > $HOME/.config/cmdify/config.toml
#
# API keys are env-var-only and are NEVER stored in or read from the config file.

# =============================================================================
# OPTIONAL — config file location
# =============================================================================
# Override the auto-discovered config file path. CLI: -c / --config takes
# precedence over this env var.
# CMDIFY_CONFIG=/path/to/cmdify/config.toml

# =============================================================================
# REQUIRED — must be set via env var or config file
# =============================================================================

# LLM provider name (also supported in config file as `provider_name`)
# Values: completions, responses, openai, anthropic, gemini, openrouter,
#         huggingface, mistral, qwen, kimi, minimax, zai, ollama
CMDIFY_PROVIDER_NAME=openrouter

# Model name to use (also supported in config file as `model_name`)
CMDIFY_MODEL_NAME=openai/gpt-5-nano

# =============================================================================
# CONDITIONALLY REQUIRED — required only when using the matching provider
# =============================================================================

# --- Generic completions provider (CMDIFY_PROVIDER_NAME=completions) ---

# Base URL of the OpenAI-compatible completions endpoint.
# Required when using the "completions" provider. Include /v1 in the path;
# cmdify appends /chat/completions automatically.
# (also supported in config file as `completions_url`)
# CMDIFY_COMPLETIONS_URL=http://localhost:8080/v1

# API key for the completions endpoint. Optional for local/self-hosted models
# (e.g. Ollama) that don't require authentication.
# CMDIFY_COMPLETIONS_KEY=

# --- Generic responses provider (CMDIFY_PROVIDER_NAME=responses) ---

# Base URL of the OpenAI-compatible responses endpoint.
# Required when using the "responses" provider. Include /v1 in the path.
# (also supported in config file as `responses_url`)
# CMDIFY_RESPONSES_URL=

# API key for the responses endpoint. Optional for local/self-hosted models.
# CMDIFY_RESPONSES_KEY=

# --- OpenAI (CMDIFY_PROVIDER_NAME=openai) ---

# OPENAI_API_KEY=sk-...

# Optional: override the default OpenAI API base URL
# OPENAI_BASE_URL=https://api.openai.com

# --- Anthropic (CMDIFY_PROVIDER_NAME=anthropic) ---

# ANTHROPIC_API_KEY=sk-ant-...

# Optional: override the default Anthropic API base URL
# ANTHROPIC_BASE_URL=https://api.anthropic.com

# --- Google Gemini (CMDIFY_PROVIDER_NAME=gemini) ---

# GEMINI_API_KEY=

# Optional: override the default Gemini API base URL
# GEMINI_BASE_URL=https://generativelanguage.googleapis.com

# --- Mistral (CMDIFY_PROVIDER_NAME=mistral) ---

# MISTRAL_API_KEY=

# Optional: override the default Mistral API base URL
# MISTRAL_BASE_URL=https://api.mistral.ai

# --- Qwen (CMDIFY_PROVIDER_NAME=qwen) ---

# QWEN_API_KEY=

# Optional: override the default Qwen API base URL
# QWEN_BASE_URL=https://dashscope-intl.aliyuncs.com/compatible-mode

# --- Kimi / Moonshot (CMDIFY_PROVIDER_NAME=kimi) ---

# KIMI_API_KEY=

# Optional: override the default Kimi API base URL
# KIMI_BASE_URL=https://api.moonshot.ai

# --- OpenRouter (CMDIFY_PROVIDER_NAME=openrouter) ---

# OPENROUTER_API_KEY=

# Optional: override the default OpenRouter API base URL
# OPENROUTER_BASE_URL=https://openrouter.ai/api

# --- HuggingFace (CMDIFY_PROVIDER_NAME=huggingface) ---

# HUGGINGFACE_API_KEY=

# Optional: override the default HuggingFace API base URL
# HUGGINGFACE_BASE_URL=https://router.huggingface.co/v1

# --- Z.ai (CMDIFY_PROVIDER_NAME=zai) ---

# ZAI_API_KEY=

# Optional: override the default Z.ai API base URL
# ZAI_BASE_URL=https://api.z.ai/api/paas/v4

# --- Minimax (CMDIFY_PROVIDER_NAME=minimax) ---

# MINIMAX_API_KEY=

# Optional: override the default Minimax API base URL
# MINIMAX_BASE_URL=https://api.minimax.io

# --- Ollama (CMDIFY_PROVIDER_NAME=ollama) ---

# Optional: override the default Ollama base URL. No API key needed.
# OLLAMA_BASE_URL=http://localhost:11434

# =============================================================================
# OPTIONAL — behavior and display settings
# =============================================================================

# Maximum tokens for the LLM response. Default: 16384.
# (also supported in config file as `max_tokens`)
# CMDIFY_MAX_TOKENS=16384

# Path to a custom system prompt file. If not set, the compiled-in prompt is used.
# The contents of this file replace the default system prompt entirely.
# (also supported in config file as `system_prompt`)
# CMDIFY_SYSTEM_PROMPT_FILE=/path/to/custom_prompt.txt

# =============================================================================
# OPTIONAL — flags (env var overrides config, CLI flag overrides both)
# =============================================================================

# Spinner style: 1 (default, classic), 2 (braille), or 3 (dots).
# (also supported in config file as `spinner`) | CLI: -s / --spinner
# CMDIFY_SPINNER=1

# Allow potentially unsafe commands (bypasses safety check).
# Values: 1/true/yes = allow, 0/false/no = block (default)
# (also supported in config file as `allow_unsafe`) | CLI: -u / --unsafe
# CMDIFY_UNSAFE=0

# Disable the ask_user tool (model cannot ask for clarification).
# Values: 1/true/yes = quiet, 0/false/no = normal (default)
# (also supported in config file as `quiet`) | CLI: -q / --quiet
# CMDIFY_QUIET=0

# Disable the find_command tool (model cannot discover available commands).
# Values: 1/true/yes = blind, 0/false/no = normal (default)
# (also supported in config file as `blind`) | CLI: -b / --blind
# CMDIFY_BLIND=0

# Disable all tools (supersedes quiet and blind).
# Values: 1/true/yes = no tools, 0/false/no = normal (default)
# (also supported in config file as `no_tools`) | CLI: -n / --no-tools
# CMDIFY_NO_TOOLS=0

# Execute the generated command after printing it.
# Values: 1/true/yes = yolo, 0/false/no = normal (default)
# (also supported in config file as `yolo`) | CLI: -y / --yolo
# CMDIFY_YOLO=0

# =============================================================================
# SYSTEM — variables used by cmdify but typically not set manually
# =============================================================================

# XDG_CONFIG_HOME — used to locate config file at $XDG_CONFIG_HOME/cmdify/config.toml
# Falls back to $HOME/.config/cmdify/config.toml if not set.

# HOME — fallback for config file location when XDG_CONFIG_HOME is not set.

# SHELL — auto-detected by cmdify. Used for shell context in the system prompt
# and as the execution shell when --yolo mode is active.