documentation / providers

AI providers

Providers translate planner requests into text. They do not execute commands, inspect the filesystem, or make safety decisions.

OpenAI-compatible

Use OpenAI or another service exposing the chat-completions shape. The API key is read at runtime from api_key_env.

environment
export OPENAI_API_KEY="…"

Ollama

Point the provider at a local Ollama server. No authorization header is sent.

configuration
[ai]
provider = "ollama"
base_url = "http://localhost:11434"
model = "llama3"

Mock provider

The deterministic mock provider is intended for tests, offline experiments, and CI. It fails closed when its response queue is exhausted.

offline plan
ASHPLUG_MOCK_RESPONSE='{"summary":"List files","steps":[{"description":"List files","command":{"program":"ls","args":["-la"]}}]}' \
  ashplug --provider mock "list files"