Configuration
kicode uses a simple configuration file and environment variables. This guide covers all configuration options.
Configuration File
kicode stores its configuration at:
~/.config/kicode/config.tomlBasic Configuration
Here’s a minimal configuration file:
# Your OpenRouter API keyapi_key = "sk-or-v1-..."
# Default model to usemodel = "anthropic/claude-3.5-sonnet"Full Configuration
# OpenRouter API key (required)api_key = "sk-or-v1-your-key-here"
# Default model (optional, defaults to x-ai/grok-code-fast-1)model = "anthropic/claude-3.5-sonnet"
# Safety settings[safety]# Additional patterns to flag as dangerous (regex)additional_patterns = [ "\\bmy-custom-dangerous-command\\b"]
# Commands that skip confirmation (use with caution)skip_confirmation = []Getting an API Key
-
Sign up for OpenRouter
Visit openrouter.ai and create an account.
-
Generate an API key
Go to openrouter.ai/keys and create a new key.
-
Configure kicode
Run the setup wizard or manually add the key:
Terminal window # Option 1: Run setup wizardkicode# (Follow the prompts)# Option 2: Set environment variableexport OPENROUTER_API_KEY="sk-or-v1-your-key"# Option 3: Edit config filemkdir -p ~/.config/kicodeecho 'api_key = "sk-or-v1-your-key"' > ~/.config/kicode/config.toml
Environment Variables
Environment variables override config file settings:
| Variable | Description | Example |
|---|---|---|
OPENROUTER_API_KEY | API key for OpenRouter | sk-or-v1-... |
KICODE_MODEL | Override default model | openai/gpt-4 |
KICODE_DEBUG | Enable debug output | 1 |
Setting Environment Variables
# Add to ~/.bashrc or ~/.zshrc for persistenceexport OPENROUTER_API_KEY="sk-or-v1-your-key-here"
# Or set per-sessionOPENROUTER_API_KEY="sk-or-v1-..." kicodeConfiguration Priority
Settings are applied in this order (later overrides earlier):
- Default values - Built-in defaults
- Config file -
~/.config/kicode/config.toml - Environment variables -
OPENROUTER_API_KEY,KICODE_MODEL - CLI arguments -
--modelflag
Example:
# Uses CLI argument over all other settingskicode --model openai/gpt-4-turboModel Selection
kicode supports any model available through OpenRouter. Common choices:
| Model | ID | Best For |
|---|---|---|
| Claude 3.5 Sonnet | anthropic/claude-3.5-sonnet | General coding, complex tasks |
| GPT-4 Turbo | openai/gpt-4-turbo | Broad knowledge, long context |
| Grok Code Fast | x-ai/grok-code-fast-1 | Fast responses (default) |
| Claude 3 Opus | anthropic/claude-3-opus | Most capable, higher cost |
See Models Reference for a complete list.
Safety Configuration
The [safety] section controls command safety analysis:
[safety]# Add custom patterns to flag as dangerousadditional_patterns = [ "\\bmy-risky-script\\b", "\\bdeploy-to-prod\\b"]
# Skip confirmation for specific safe commands (advanced)skip_confirmation = []Configuration Directory Structure
Directory~/.config/kicode/
- config.toml Main configuration file
Validating Configuration
Check your configuration is valid:
# Start kicode - it will report config errorskicode
# Check model is set correctlykicode --model invalid-model# Error: Unknown model: invalid-modelNext Steps
Learn how to use kicode in your First Session.