Kode Documentation

The KODE SDK tool system allows agents to interact with the environment through built-in and custom tools. Key features include:

• Prompt Instructions: Detailed guidance for models to ensure safe usage.
• Structured Returns: Tools return predictable JSON structures.
• FilePool Integration: File tools use FilePool to validate freshness and prevent conflicts during reads/writes.
• Audit Trail: ToolCallRecord tracks approvals, duration, and errors, supporting full restoration on Resume.
• MCP Integration: Supports Model Context Protocol (MCP) via ToolRegistry.registerMCPLoader.

The configuration system manages reading and writing settings, default values, and model profiles/pointers. It is responsible for:

• Reading configurations: Loads settings from user-level (~/.kode.json) and project-level (./.kode.json) files.
• Managing Model Profiles: Maintains model profiles and pointers (e.g., main, task, quick, compact) along with compatibility aliases.
• Configuration Maintenance: Handles version migrations and automatic configuration repairs (best-effort, designed not to interfere with standard workflows).

The packages/runtime-node package provides the Node.js implementation of the Runtime interface defined in packages/runtime. It serves as the default/baseline runtime for the core and headless engines. It provides implementations for the following system capabilities:

• fs: File system operations
• spawn: Process spawning
• env: Environment variable access
• os: Operating system information
• clock: Time and clock functions
• log: Logging utilities

The Arctic Frost theme is a winter-inspired visual style designed for clarity, precision, and professionalism. It is characterized by a cool color palette and clean typography.

Color Palette

• Ice Blue: #d4e4f7 (Light backgrounds and highlights)
• Steel Blue: #4a6fa5 (Primary accent color)
• Silver: #c0c0c0 (Metallic accent elements)
• Crisp White: #fafafa (Clean backgrounds and text)

Typography

• Headers: DejaVu Sans Bold
• Body Text: DejaVu Sans

Recommended Use Cases

This theme is best suited for:

• Healthcare presentations
• Technology solutions
• Winter sports
• Clean tech
• Pharmaceutical content

The @kode/runtime package provides an abstraction layer for essential runtime capabilities such as file system (fs), process spawning (spawn), environment variables (env), current working directory (cwd), clock, and logging.

This abstraction allows the @kode/core package to depend on high-level runtime interfaces rather than specific platform implementations. This design enables the core logic to remain platform-agnostic.

The Forest Canopy theme provides a natural and grounded aesthetic using earth tones inspired by dense forest environments. It is characterized by the following design specifications:

Color Palette

• Forest Green: #2d4a2b (Primary dark green)
• Sage: #7d8471 (Muted green accent)
• Olive: #a4ac86 (Light accent color)
• Ivory: #faf9f6 (Backgrounds and text)

Typography

• Headers: FreeSerif Bold
• Body Text: FreeSans

The KODE SDK organizes events into three distinct channels based on their purpose and intended subscriber:

• progress: Used for streaming output such as text chunks and tool calls. Typically consumed by a User Interface.
• control: Used for permission requests and decision-making. Typically consumed by Business Logic.
• monitor: Used for system observability, including errors, token usage, and state changes. Typically consumed by Monitoring or Logging systems.

The packages/runtime-bun package provides a Bun-based implementation of the packages/runtime interface. It encapsulates Bun's native file and process capabilities to provide a high-performance execution path.

Use this implementation for:

• Development and experimental scenarios requiring Bun's features.
• Binary build scenarios where single-file executables are created using bun --compile (refer to docs/binary-distribution.md for details).

Note: The default runtime baseline for npm packages is Node.js.

The webapp-testing skill is a toolkit for interacting with and testing local web applications using Playwright. It supports verifying frontend functionality, debugging UI behavior, capturing browser screenshots, and viewing browser logs.

Approach Selection

• Static HTML: Read the HTML file directly to identify selectors, then write a Playwright script using those selectors.
• Dynamic Webapps:
  • If the server is not running: Use the scripts/with_server.py helper to manage the server lifecycle.
  • If the server is running: Use a 'Reconnaissance-then-action' pattern: navigate and wait for networkidle, take a screenshot or inspect the DOM to identify selectors, and then execute actions.