mkdocs.yml

site_name: Shekel
site_description: "Shekel: LLM budget control and AI agent cost governance for Python. Hard spend caps, loop detection, velocity limits, and distributed enforcement for OpenAI, Anthropic, LangGraph, CrewAI, and LiteLLM. One line, zero config."
site_author: Arie Radle
site_url: https://arieradle.github.io/shekel/

repo_name: arieradle/shekel
repo_url: https://github.com/arieradle/shekel
edit_uri: edit/main/docs/

theme:
  name: material
  language: en
  custom_dir: docs/overrides
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
  
  icon:
    repo: fontawesome/brands/github
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/light-bulb-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16

extra_css:
  - stylesheets/extra.css

extra:
  analytics:
    provider: google
    property: G-YJDLR6LJLG
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/arieradle/shekel
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/shekel/
  
  version:
    provider: mike
  
  # SEO metadata
  generator: false

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - tags:
  - social:
      enabled: !ENV [CI, false]
      cards_layout_options:
        background_color: "#3f51b5"
        color: "#ffffff"
  - minify:
      enabled: !ENV [CI, false]
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
  - rss:
      enabled: !ENV [CI, false]
      match_path: ".*"
      date_from_meta:
        as_creation: date
      categories:
        - tags
  - llmstxt:
      full_output: "llms-full.txt"
      markdown_description: |
        Shekel enforces hard LLM spend limits in Python with one line of code.
        Supports OpenAI, Anthropic, LiteLLM, Gemini, LangGraph, CrewAI, OpenAI Agents SDK, MCP, and more.
        Key features: hard USD caps, loop detection, velocity limits, per-node/agent/task circuit breakers, Redis distributed budgets.
      sections:
        Getting Started:
          - index.md
          - installation.md
          - quickstart.md
        Usage Guide:
          - usage/basic-usage.md
          - usage/nested-budgets.md
          - usage/budget-enforcement.md
          - usage/fallback-models.md
          - usage/loop-guard.md
          - usage/spend-velocity.md
          - usage/tool-budgets.md
          - usage/temporal-budgets.md
          - usage/distributed-budgets.md
          - usage/accumulating-budgets.md
          - usage/streaming.md
          - usage/decorators.md
        Integrations:
          - integrations/litellm.md
          - integrations/langgraph.md
          - integrations/crewai.md
          - integrations/openai-agents.md
          - integrations/openai.md
          - integrations/anthropic.md
          - integrations/gemini.md
          - integrations/huggingface.md
          - integrations/langfuse.md
          - integrations/otel.md
        Reference:
          - cli.md
          - docker.md
          - api-reference.md
          - models.md
        Architecture:
          - how-it-works.md
          - architecture/overview.md
          - architecture/components.md
          - architecture/data-flow.md
          - architecture/extensibility.md
          - architecture/concurrency.md
  - mermaid2

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - meta

nav:
  - Home: index.md
  - Getting Started:
    - Installation: installation.md
    - Quick Start: quickstart.md
  - Usage Guide:
    - Basic Usage: usage/basic-usage.md
    - Nested Budgets: usage/nested-budgets.md
    - Budget Enforcement: usage/budget-enforcement.md
    - Fallback Models: usage/fallback-models.md
    - Loop Guard: usage/loop-guard.md
    - Spend Velocity: usage/spend-velocity.md
    - Tool Budgets: usage/tool-budgets.md
    - Temporal Budgets: usage/temporal-budgets.md
    - Distributed Budgets: usage/distributed-budgets.md
    - Accumulating Budgets: usage/accumulating-budgets.md
    - Streaming: usage/streaming.md
    - Decorators: usage/decorators.md
  - Integrations:
    - LiteLLM: integrations/litellm.md
    - LangGraph: integrations/langgraph.md
    - CrewAI: integrations/crewai.md
    - OpenAI Agents SDK: integrations/openai-agents.md
    - OpenAI: integrations/openai.md
    - Anthropic: integrations/anthropic.md
    - Google Gemini: integrations/gemini.md
    - HuggingFace: integrations/huggingface.md
    - Langfuse: integrations/langfuse.md
    - OpenTelemetry: integrations/otel.md
  - Reference:
    - CLI Tools: cli.md
    - Docker & Containers: docker.md
    - API Reference: api-reference.md
    - Supported Models: models.md
    - Changelog: changelog.md
    - Tags: tags.md
  - Architecture:
    - Introduction: architecture/index.md
    - Overview: architecture/overview.md
    - Core Components: architecture/components.md
    - Data Flow: architecture/data-flow.md
    - Module Map: architecture/module-map.md
    - Extensibility: architecture/extensibility.md
    - Concurrency & Safety: architecture/concurrency.md
  - Advanced:
    - How It Works: how-it-works.md
    - Extending Shekel: extending.md
    - Contributing: contributing.md

copyright: Copyright © 2024-2026 Arie Radle