mirror of
https://github.com/outbackdingo/optimclaw.git
synced 2026-08-25 14:53:34 +00:00
7f68207f1e
* feat: add OpenRouter usage examples * feat: add HTPS headers * feat: add shell completion generation via clap_complete * feat: add shell completion generation via clap_complete * feat: add shell completion generation via clap_complete * Refactor completion: use clap_complete::Shell directly, improve tests, remove tracing duplication, fix .env.example and Cargo.toml * fix: rename init_cli_logging to init_cli_tracing (sync with main) --------- Co-authored-by: BroccoliFin <[email protected]> Co-authored-by: firat.sertgoz <[email protected]>
109 lines
3.6 KiB
Bash
109 lines
3.6 KiB
Bash
# Database Configuration
|
|
DATABASE_URL=postgres://localhost/ironclaw
|
|
DATABASE_POOL_SIZE=10
|
|
|
|
# LLM Provider
|
|
# LLM_BACKEND=nearai # default
|
|
# Possible values: nearai, ollama, openai_compatible, openai, anthropic, tinfoil
|
|
|
|
# === NEAR AI (Chat Completions API) ===
|
|
# Two auth modes:
|
|
# 1. Session token (default): Uses browser OAuth (GitHub/Google) on first run.
|
|
# Session token stored in ~/.ironclaw/session.json automatically.
|
|
# Base URL defaults to https://private.near.ai
|
|
# 2. API key: Set NEARAI_API_KEY to use API key auth from cloud.near.ai.
|
|
# Base URL defaults to https://cloud-api.near.ai
|
|
NEARAI_MODEL=zai-org/GLM-5-FP8
|
|
NEARAI_BASE_URL=https://private.near.ai
|
|
NEARAI_AUTH_URL=https://private.near.ai
|
|
# NEARAI_SESSION_TOKEN=sess_... # hosting providers: set this
|
|
# NEARAI_SESSION_PATH=~/.ironclaw/session.json # optional, default shown
|
|
# NEARAI_API_KEY=... # API key from cloud.near.ai
|
|
|
|
# Local LLM Providers (Ollama, LM Studio, vLLM, LiteLLM)
|
|
|
|
# === Ollama ===
|
|
# OLLAMA_MODEL=llama3.2
|
|
# LLM_BACKEND=ollama
|
|
# OLLAMA_BASE_URL=http://localhost:11434 # default
|
|
|
|
# === OpenAI-compatible (LM Studio, vLLM, Anything-LLM) ===
|
|
# LLM_MODEL=llama-3.2-3b-instruct-q4_K_M
|
|
# LLM_BACKEND=openai_compatible
|
|
# LLM_BASE_URL=http://localhost:1234/v1
|
|
# LLM_API_KEY=sk-... # optional for local servers
|
|
# Custom HTTP headers for OpenAI-compatible providers
|
|
# Format: comma-separated key:value pairs
|
|
# LLM_EXTRA_HEADERS=HTTP-Referer:https://github.com/nearai/ironclaw,X-Title:ironclaw
|
|
|
|
# === OpenRouter (300+ models via OpenAI-compatible) ===
|
|
# LLM_MODEL=anthropic/claude-sonnet-4 # see openrouter.ai/models for IDs
|
|
# LLM_BACKEND=openai_compatible
|
|
# LLM_BASE_URL=https://openrouter.ai/api/v1
|
|
# LLM_API_KEY=sk-or-...
|
|
|
|
# LLM_EXTRA_HEADERS=HTTP-Referer:https://myapp.com,X-Title:MyApp
|
|
|
|
|
|
# === Together AI (via OpenAI-compatible) ===
|
|
# LLM_MODEL=meta-llama/Llama-3.3-70B-Instruct-Turbo
|
|
# LLM_BACKEND=openai_compatible
|
|
# LLM_BASE_URL=https://api.together.xyz/v1
|
|
# LLM_API_KEY=...
|
|
|
|
# === Fireworks AI (via OpenAI-compatible) ===
|
|
# LLM_MODEL=accounts/fireworks/models/llama4-maverick-instruct-basic
|
|
# LLM_BACKEND=openai_compatible
|
|
# LLM_BASE_URL=https://api.fireworks.ai/inference/v1
|
|
# LLM_API_KEY=fw_...
|
|
|
|
# For full provider setup guide see docs/LLM_PROVIDERS.md
|
|
|
|
# Channel Configuration
|
|
# CLI is always enabled
|
|
|
|
# Slack Bot (optional)
|
|
SLACK_BOT_TOKEN=xoxb-...
|
|
SLACK_APP_TOKEN=xapp-...
|
|
SLACK_SIGNING_SECRET=...
|
|
|
|
# Telegram Bot (optional)
|
|
TELEGRAM_BOT_TOKEN=...
|
|
|
|
# HTTP Webhook Server (optional)
|
|
HTTP_HOST=0.0.0.0
|
|
HTTP_PORT=8080
|
|
HTTP_WEBHOOK_SECRET=your-webhook-secret
|
|
|
|
# Agent Settings
|
|
AGENT_NAME=ironclaw
|
|
AGENT_MAX_PARALLEL_JOBS=5
|
|
AGENT_JOB_TIMEOUT_SECS=3600
|
|
AGENT_STUCK_THRESHOLD_SECS=300
|
|
# Enable planning phase before tool execution (default: true)
|
|
AGENT_USE_PLANNING=true
|
|
|
|
# Self-repair settings
|
|
SELF_REPAIR_CHECK_INTERVAL_SECS=60
|
|
SELF_REPAIR_MAX_ATTEMPTS=3
|
|
|
|
# Heartbeat settings (proactive periodic execution)
|
|
# When enabled, reads HEARTBEAT.md checklist and reports findings
|
|
HEARTBEAT_ENABLED=false
|
|
HEARTBEAT_INTERVAL_SECS=1800
|
|
HEARTBEAT_NOTIFY_CHANNEL=cli
|
|
HEARTBEAT_NOTIFY_USER=default
|
|
|
|
# Memory hygiene settings (automatic cleanup of stale workspace documents)
|
|
# Runs on each heartbeat tick; identity files (IDENTITY.md, SOUL.md) are never deleted
|
|
# MEMORY_HYGIENE_ENABLED=true
|
|
# MEMORY_HYGIENE_RETENTION_DAYS=30 # delete daily/ docs older than this many days
|
|
# MEMORY_HYGIENE_CADENCE_HOURS=12 # minimum hours between cleanup passes
|
|
|
|
# Safety settings
|
|
SAFETY_MAX_OUTPUT_LENGTH=100000
|
|
SAFETY_INJECTION_CHECK_ENABLED=true
|
|
|
|
# Logging
|
|
RUST_LOG=ironclaw=debug,tower_http=debug
|