// guides · config

Configuration examples

Copy/adapt ready-made files for common setups instead of composing YAML from scratch.

Available files

file	use
`docs/examples/lmstudio.local.yaml`	Local OpenAI-compatible LMStudio provider.
`docs/examples/codex.local.yaml`	Codex via OAuth/subscription.
`docs/examples/claude.local.yaml`	Claude via authenticated CLI.
`docs/examples/telegram-agent.yaml`	Telegram-routed agent.
`docs/examples/production-strict.yaml`	Hardened posture for exposed gateway/API.
`docs/examples/mcp.github.yaml`	GitHub MCP server with token from env.

Local provider: LMStudio

docs/examples/lmstudio.local.yaml

default_provider: lmstudio
providers:
  lmstudio:
    model: openai/qwen3.5-4b-mtp
    api_base: http://localhost:4480/v1
    api_key: lm-studio
    auth: api_key
    tier: local
    context_window: 32768

Strong provider: Codex

docs/examples/codex.local.yaml

default_provider: codex
providers:
  codex:
    model: openai-codex/gpt-5.5
    auth: oauth_subscription
    transport: codex_oauth
    tier: strong
    context_window: 256000
    reasoning_effort: high

Production gateway/API

docs/examples/production-strict.yaml

approval:
  mode: smart
gateway:
  require_token: true
security:
  forbid_public_bind: true
sandbox:
  require_isolation: true
  backend: docker
retention:
  sessions: { days: 30, keep: 10 }
  checkpoints: { days: 14, keep: 50 }
  tool_outputs: { days: 7, keep: 200 }

Telegram agent

docs/examples/telegram-agent.yaml

agents:
  support:
    name: Support
    match:
      - telegram:*
    telegram:
      token_env: TELEGRAM_TOKEN
gateway:
  reactions: true
  max_sessions: 500

GitHub MCP

docs/examples/mcp.github.yaml

mcp:
  github:
    command: npx
    args:
      - -y
      - "@modelcontextprotocol/server-github"
    env:
      GITHUB_PERSONAL_ACCESS_TOKEN: ${GITHUB_TOKEN}

Apply as a local base

cp docs/examples/lmstudio.local.yaml okami.local.yaml
okami doctor
okami chat

Compose snippets

The examples are intentionally small. Use them as patches: copy the relevant block into okami.local.yaml or an agent-specific agent.yaml, keeping secrets in .env.

Checklist before use

okami doctor --lintcheck provider, auth, toolchain, sandbox and posture

okami policy check --strictrequired before exposing gateway/API

okami config showconfirm effective config without exposing secrets

okami auth listaudit which providers are authenticated

Config schemaReal keys extracted from okami.yaml.Providers & authHow authentication and transports combine.Self-hostingDocker, API and gateway isolation.

Open this page in the interactive docs