Skip to content

config.md

Latest commit

 

History

History
176 lines (129 loc) · 4.25 KB

config.md

File metadata and controls

176 lines (129 loc) · 4.25 KB

Configuration

Mini-Kode uses a simplified configuration system with global-only settings and project-specific permissions.

Quick Start

DeepSeek (Recommended)

export DEEPSEEK_API_KEY="your-key"
mini-kode config set llm.model deepseek-chat
mini-kode config set theme dark

OpenAI

export OPENAI_API_KEY="your-key"
mini-kode config set llm.model gpt-4

Custom API

export MINIKODE_API_KEY="your-key"
export MINIKODE_BASE_URL="https://your-api.com/v1"
export MINIKODE_MODEL="your-model"

Configuration Architecture

The configuration system has been simplified with clear separation of concerns:

Global Configuration (~/.mini-kode/config.json)

  • Purpose: User preferences and LLM settings
  • Scope: Global across all projects (no project-level config)
  • Content: Non-sensitive settings only
  • Commands: All config commands operate globally

Project Permissions (.mini-kode/permissions.json)

  • Purpose: Project-specific access permissions
  • Scope: Individual projects only
  • Content: File system and command access grants
  • Separation: Stored independently from global config

Configuration Priority

Since configuration is global-only, settings are resolved in this order (highest to lowest):

  1. Environment variables - MINIKODE_*, DEEPSEEK_API_KEY, OPENAI_API_KEY
  2. Global config file - ~/.mini-kode/config.json
  3. Default values - Built-in fallbacks

Global Configuration Settings

LLM Configuration

  • llm.baseURL - API endpoint
  • llm.model - Primary model
  • llm.planModel - Architecture model (inherits from model if not set)

UI Settings

  • theme - UI theme mode:
    • light - Light theme (default)
    • dark - Dark theme

Environment Variables

Auto-Configuration (Recommended)

  • DEEPSEEK_API_KEY → Auto-configures DeepSeek settings
  • OPENAI_API_KEY → Auto-configures OpenAI settings

Manual Configuration

  • MINIKODE_API_KEY - Your API key
  • MINIKODE_BASE_URL - Custom API endpoint
  • MINIKODE_MODEL - Custom model name
  • MINIKODE_PLAN_MODEL - Custom planning model

CLI Commands

# View configuration (always global)
mini-kode config list
mini-kode config list --show-sources    # Show where values come from

# Get/set values (always global)
mini-kode config get llm.model
mini-kode config set llm.model gpt-4
mini-kode config set theme dark

# Delete settings (always global)
mini-kode config delete llm.model

Configuration Files

Global Config (~/.mini-kode/config.json)

{
  "llm": {
    "baseURL": "https://api.deepseek.com/v1",
    "model": "deepseek-chat",
    "planModel": "deepseek-chat"
  },
  "theme": "dark"
}

Project Permissions (.mini-kode/permissions.json)

{
  "grants": [
    {
      "type": "fs",
      "pattern": "/project/src/**",
      "grantedAt": "2024-01-01T12:00:00.000Z"
    },
    {
      "type": "bash",
      "pattern": "npm:*",
      "grantedAt": "2024-01-01T12:00:00.000Z"
    }
  ]
}

MCP Configuration

Mini-Kode supports Model Context Protocol (MCP) servers. Create .mini-kode/mcp.json in your project:

Supported Transports

  • stdio: Local command-line servers
  • http: HTTP-based servers

Environment Variables

Use ${ENV_VAR} syntax in args and headers for secure configuration. Mini-Kode automatically resolves these references from your environment:

{
  "servers": {
    "context7": {
      "transport": "stdio",
      "command": "npx",
      "args": ["-y", "@upstash/context7-mcp"]
    },
    "chrome-devtools": {
      "transport": "stdio",
      "command": "npx",
      "args": ["-y", "chrome-devtools-mcp@latest", "--isolated=true"]
    }
  }
}

How it works:

  • ${ENV_VAR} patterns in args and headers are automatically replaced with actual environment variable values
  • For stdio transport: environment variables are resolved in command arguments
  • For HTTP transport: environment variables are resolved in request headers
  • If environment variable is not found, the original ${ENV_VAR} text is kept

Security

  • API keys are never stored in config files
  • Use environment variables for API keys
  • Global config only contains non-sensitive settings
  • Permissions are project-specific and stored separately