Directories
¶
| Path | Synopsis |
|---|---|
|
Package acp implements the Agent Communication Protocol — a WebSocket-based protocol that lets any client interact with an OK agent.
|
Package acp implements the Agent Communication Protocol — a WebSocket-based protocol that lets any client interact with an OK agent. |
|
Package agent implements the LLM agent run-loop.
|
Package agent implements the LLM agent run-loop. |
|
computeruse
Package agent provides the ComputerUse orchestrator — a screenshot→analyze→act→verify loop that lets the agent control the desktop GUI.
|
Package agent provides the ComputerUse orchestrator — a screenshot→analyze→act→verify loop that lets the agent control the desktop GUI. |
|
Package atomizer provides deterministic helpers for extracting structured content from LLM output.
|
Package atomizer provides deterministic helpers for extracting structured content from LLM output. |
|
bench
|
|
|
swebench
Package swebench was removed — unused.
|
Package swebench was removed — unused. |
|
Package billing queries a provider's wallet balance for the status line.
|
Package billing queries a provider's wallet balance for the status line. |
|
Package boot initializes and assembles all components of the OK agent: config, providers, tools, plugins, permissions, hooks, memory, semantic search, and the controller.
|
Package boot initializes and assembles all components of the OK agent: config, providers, tools, plugins, permissions, hooks, memory, semantic search, and the controller. |
|
Package bridge defines the agent-to-agent protocol that allows OK instances to discover each other and share tasks.
|
Package bridge defines the agent-to-agent protocol that allows OK instances to discover each other and share tasks. |
|
Package brief generates a concise project overview (OK-BRIEF.md) that gives the AI agent immediate context at session start.
|
Package brief generates a concise project overview (OK-BRIEF.md) that gives the AI agent immediate context at session start. |
|
Package browser — multi-backend browser automation engine.
|
Package browser — multi-backend browser automation engine. |
|
Package bus is a lightweight publish-subscribe message bus.
|
Package bus is a lightweight publish-subscribe message bus. |
|
Package cli implements ok's command-line entry: subcommand routing, flag parsing, assembly from config, and exit codes.
|
Package cli implements ok's command-line entry: subcommand routing, flag parsing, assembly from config, and exit codes. |
|
Package codegraph integrates the CodeGraph code-intelligence engine (https://github.com/colbymchenry/codegraph) as a built-in MCP server.
|
Package codegraph integrates the CodeGraph code-intelligence engine (https://github.com/colbymchenry/codegraph) as a built-in MCP server. |
|
Package command loads custom slash commands from Markdown files.
|
Package command loads custom slash commands from Markdown files. |
|
Package config — provider auto-discovery from environment.
|
Package config — provider auto-discovery from environment. |
|
Package context7 integrates the Context7 MCP server (https://github.com/upstash/context7) as an auto-discovered built-in plugin.
|
Package context7 integrates the Context7 MCP server (https://github.com/upstash/context7) as an auto-discovered built-in plugin. |
|
Package control is the transport-agnostic session driver.
|
Package control is the transport-agnostic session driver. |
|
Package core defines DST-Lite's core types: ProofChain (a tamper-evident hash chain).
|
Package core defines DST-Lite's core types: ProofChain (a tamper-evident hash chain). |
|
Package diff computes a line-level diff between two versions of a file and renders it as a unified diff, with added/removed line counts.
|
Package diff computes a line-level diff between two versions of a file and renders it as a unified diff, with added/removed line counts. |
|
Package dstsetup wires compile/test regression checks into an Agent.
|
Package dstsetup wires compile/test regression checks into an Agent. |
|
Package dstvalid implements synchronous compile/test regression hooks.
|
Package dstvalid implements synchronous compile/test regression hooks. |
|
Package enterprise provides enterprise-grade features for OK: SSO, RBAC, audit exports, session persistence, air-gap mode, and metrics.
|
Package enterprise provides enterprise-grade features for OK: SSO, RBAC, audit exports, session persistence, air-gap mode, and metrics. |
|
Package env provides environment awareness for both humans (ok doctor) and the AI agent (system-prompt injection).
|
Package env provides environment awareness for both humans (ok doctor) and the AI agent (system-prompt injection). |
|
Package event defines the typed event stream the agent emits as it runs a turn, and the Sink it emits to.
|
Package event defines the typed event stream the agent emits as it runs a turn, and the Sink it emits to. |
|
Package eventpipe implements a Reasonix-inspired event-sourcing pipeline: discriminated-union typed events → pure-function reducer projections → composable sink middleware chain → JSONL event log.
|
Package eventpipe implements a Reasonix-inspired event-sourcing pipeline: discriminated-union typed events → pure-function reducer projections → composable sink middleware chain → JSONL event log. |
|
Package evolution — Gap 4: Evolution Control Protocol (ECP).
|
Package evolution — Gap 4: Evolution Control Protocol (ECP). |
|
Package fetch was removed — unused.
|
Package fetch was removed — unused. |
|
Package frontmatter parses YAML-like frontmatter ("---" ...
|
Package frontmatter parses YAML-like frontmatter ("---" ... |
|
Package hook runs user-configured shell-command hooks around the agent loop: PreToolUse / PostToolUse fire around each tool call, UserPromptSubmit before a turn, Stop after it.
|
Package hook runs user-configured shell-command hooks around the agent loop: PreToolUse / PostToolUse fire around each tool call, UserPromptSubmit before a turn, Stop after it. |
|
Package i18n holds the CLI's translatable strings and a small detection helper.
|
Package i18n holds the CLI's translatable strings and a small detection helper. |
|
Package imbot provides a shared IM bot framework for connecting messaging platforms (Telegram, 企业微信, 飞书, Discord, etc.) to an OK Agent via ACP.
|
Package imbot provides a shared IM bot framework for connecting messaging platforms (Telegram, 企业微信, 飞书, Discord, etc.) to an OK Agent via ACP. |
|
Package jobs is the session-scoped background-job registry behind the agent's background tools (bash run_in_background, task run_in_background) and the bash_output / kill_shell / wait tools.
|
Package jobs is the session-scoped background-job registry behind the agent's background tools (bash run_in_background, task run_in_background) and the bash_output / kill_shell / wait tools. |
|
Package kernel — civilization primitives.
|
Package kernel — civilization primitives. |
|
adapter
Package adapter provides concrete implementations of the kernel interfaces.
|
Package adapter provides concrete implementations of the kernel interfaces. |
|
Package log is a thin wrapper around log/slog that writes structured logs to stderr.
|
Package log is a thin wrapper around log/slog that writes structured logs to stderr. |
|
Package mcpserver exposes OK's tool registry as an MCP server over stdio.
|
Package mcpserver exposes OK's tool registry as an MCP server over stdio. |
|
Package memory implements OK's persistent memory.
|
Package memory implements OK's persistent memory. |
|
Package metrics is a zero-dependency, lock-free performance counter registry embedded in the agent.
|
Package metrics is a zero-dependency, lock-free performance counter registry embedded in the agent. |
|
Package permission implements a three-layer authorization model:
|
Package permission implements a three-layer authorization model: |
|
Package plugin is OK's MCP client.
|
Package plugin is OK's MCP client. |
|
registry
Package reg provides the v4 multi-registry plugin manager.
|
Package reg provides the v4 multi-registry plugin manager. |
|
Package provider defines the model-backend abstraction and a registry mapping a provider "kind" to a factory.
|
Package provider defines the model-backend abstraction and a registry mapping a provider "kind" to a factory. |
|
anthropic
Package anthropic implements the Anthropic Claude Messages API provider.
|
Package anthropic implements the Anthropic Claude Messages API provider. |
|
ollama
Package ollama registers a local-model provider that speaks the Ollama OpenAI-compatible API (http://localhost:11434/v1).
|
Package ollama registers a local-model provider that speaks the Ollama OpenAI-compatible API (http://localhost:11434/v1). |
|
openai
Package openai implements the OpenAI-compatible /chat/completions provider.
|
Package openai implements the OpenAI-compatible /chat/completions provider. |
|
Package safeclose provides a helper to safely close resources with error logging.
|
Package safeclose provides a helper to safely close resources with error logging. |
|
Package sandbox provides OS-level sandboxing for agent-executed commands.
|
Package sandbox provides OS-level sandboxing for agent-executed commands. |
|
Package semantic provides local semantic code search using Ollama embeddings.
|
Package semantic provides local semantic code search using Ollama embeddings. |
|
Package serve exposes a control.Controller over HTTP: the typed event stream as Server-Sent Events, and the commands as small JSON POST endpoints.
|
Package serve exposes a control.Controller over HTTP: the typed event stream as Server-Sent Events, and the commands as small JSON POST endpoints. |
|
Package skill loads invokable playbooks ("skills") from Markdown files.
|
Package skill loads invokable playbooks ("skills") from Markdown files. |
|
Package slashcmd is the slash-command dispatcher — extracted from control.Controller to keep the turn loop lean.
|
Package slashcmd is the slash-command dispatcher — extracted from control.Controller to keep the turn loop lean. |
|
Package tool defines the Tool abstraction and a Registry.
|
Package tool defines the Tool abstraction and a Registry. |
|
builtin
Package builtin provides the built-in tools for the OK agent.
|
Package builtin provides the built-in tools for the OK agent. |
|
Package verification provides analyzers for the ok-verify vet tool.
|
Package verification provides analyzers for the ok-verify vet tool. |
|
v2
Package v2 — world-class static analysis platform.
|
Package v2 — world-class static analysis platform. |
|
Package voice provides speech-to-text and text-to-speech engines.
|
Package voice provides speech-to-text and text-to-speech engines. |
|
Package winhide provides a cross-platform helper to hide console windows when spawning external commands.
|
Package winhide provides a cross-platform helper to hide console windows when spawning external commands. |
Click to show internal directories.
Click to hide internal directories.