Reference

Reference pages describe the facts: what exists, with which names, types and defaults.

• Configuration: the keys of blaise.yml, hidden keys and !include.
• Expressions: ${{ }} syntax, contexts, types and timing.
• Resolving plugs: how use: becomes a module, and the load-time checks.
• Plug API: definePlug, handlers and the context.
• Host API: createHost, wrapHost, the file system providers, SSH, byte streams and the SSH test server.
• Shipped plugs: shell, env, git/worktree, git/clone, mcp-servers, mise and ssh, and the docker and sandbox packages.
• Session settings and states: the agent's idle policy and paused lifetime, the states of an environment, and the stop directive.
• Persisted state: the record Blaise keeps for a plug, its limits, and how it is loaded and migrated.
• Command line: how listen finds and uses blaise.yml.
• Error messages: what the runner reports when something is wrong, and what each message means.

Generated from the code, so that they cannot drift from it:

• Configuration keys: every key of blaise.yml, from its JSON Schema.
• Plug API types: the declarations and TSDoc of @blaiseagent/runner that plug authors use.
• Host API types: the declarations of @blaiseagent/runner/host.
• Testing API types: the declarations of @blaiseagent/runner/testing.
• Runner API types: the API the CLI uses to run sessions.

A JSON Schema for editors is published with the package as agent-config.v1.schema.json. Add this line at the top of blaise.yml to use it:

# yaml-language-server: $schema=https://askblaise.com/schemas/agent-config.v1.json