apollo-agent 0.5.0

Local-first Rust AI agent runtime — Telegram-first, trait-driven, SurrealDB + RocksDB state layer.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
//! Runtime/bootstrap helpers used by the CLI entrypoint.

use std::path::Path;
use std::sync::Arc;

use crate::config::Config;
use crate::memory::embeddings::{create_embedding_provider, EmbeddingProvider};
use crate::memory::search::{MemoryGetTool, MemorySearchTool, SessionSearchTool};
use crate::memory::surreal::SurrealMemory;
use crate::memory::MemoryBackend;
use crate::policy::ExecutionPolicy;
#[cfg(feature = "rs-ai")]
use crate::providers::codex::CodexProvider;
use crate::providers::defaults::default_model_for_provider;
#[cfg(feature = "provider-ollama")]
use crate::providers::ollama::OllamaProvider;
use crate::providers::openai_compat::OpenAiCompatProvider;
use crate::providers::Provider;
use crate::tools::build_runner::BuildRunnerTool;
use crate::tools::embeddings::{EmbeddingSearchTool, EmbeddingStatusTool, EmbeddingStoreTool};
use crate::tools::file_ops::{FileReadTool, FileWriteTool};
use crate::tools::shell::ShellTool;
#[cfg(feature = "plugin-skills")]
use crate::tools::skill_manager::SkillManagerTool;
use crate::tools::toolsets::is_tool_enabled;
use crate::tools::{BriefTool, ConfigTool, SleepTool, TodoWriteTool, Tool};
#[cfg(feature = "plugin-advanced")]
use crate::tools::{VibemaniaTool, WorktreeTool};

pub fn load_config(path: &str) -> Config {
    load_config_workspace(path, None)
}

pub fn require_config_file(path: &str) -> anyhow::Result<()> {
    if !Path::new(path).exists() {
        anyhow::bail!("Config not found at {path}. Run `apollo init` to create one.");
    }
    Ok(())
}

pub fn load_config_workspace(path: &str, workspace: Option<&Path>) -> Config {
    let mut cfg = Config::load(path).unwrap_or_else(|_| {
        tracing::warn!("Config not found at {}, using defaults", path);
        Config::default_config()
    });
    if let Some(ws) = workspace {
        crate::plugins::apply_workspace_manifest(&mut cfg, ws);
    }

    if matches!(cfg.provider.name.as_str(), "anthropic" | "claude") {
        cfg.provider.name = "chatgpt".to_string();
        cfg.provider.api_key = None;
        if cfg.model.starts_with("claude") {
            cfg.model = "gpt-5.5".to_string();
        }
    }

    if cfg.provider.api_key.is_none() {
        #[cfg(feature = "rs-ai")]
        if let Some((token, _, _)) =
            crate::providers::shared_credentials::load(rs_ai_oauth::OAuthProvider::ChatGpt)
        {
            cfg.provider.name = "chatgpt".to_string();
            cfg.provider.api_key = Some(token);
        }
    }

    if cfg.provider.api_key.is_none() {
        if let Ok(key) = std::env::var("OPENAI_API_KEY") {
            cfg.provider.name = "openai".to_string();
            cfg.provider.api_key = Some(key);
        }
    }

    if cfg.provider.name == "ollama" && cfg.provider.base_url.is_none() {
        if let Ok(url) = std::env::var("OLLAMA_BASE_URL") {
            cfg.provider.base_url = Some(url);
        }
    }

    if cfg.embeddings.api_key.is_none() {
        match cfg.embeddings.provider.as_str() {
            "openai" | "openai_compat" => {
                if let Ok(key) = std::env::var("OPENAI_API_KEY") {
                    cfg.embeddings.api_key = Some(key);
                }
            }
            "ollama" | "local" => {
                if cfg.embeddings.base_url.is_none() {
                    if let Ok(url) = std::env::var("OLLAMA_BASE_URL") {
                        cfg.embeddings.base_url = Some(url);
                    }
                }
            }
            "gemini" => {
                if let Ok(key) = std::env::var("GEMINI_API_KEY") {
                    cfg.embeddings.api_key = Some(key);
                }
            }
            _ => {}
        }
    }

    apply_default_model(&mut cfg);

    cfg
}

/// Fill in the model for the configured provider when none was chosen.
///
/// Credential detection can change the provider, so this runs once at the end
/// from whichever provider actually won. It only ever fills a blank: a model
/// already in the config is never replaced, including when the credential that
/// was detected belongs to a different provider.
fn apply_default_model(cfg: &mut Config) {
    if !cfg.model.trim().is_empty() {
        return;
    }
    if let Some(model) = default_model_for_provider(&cfg.provider.name) {
        cfg.model = model.to_string();
    }
}

pub fn build_provider(cfg: &Config) -> Arc<dyn Provider> {
    let api_key = cfg.provider.api_key.clone().unwrap_or_default();

    match cfg.provider.name.as_str() {
        #[cfg(feature = "rs-ai")]
        "chatgpt" => Arc::new(CodexProvider::new(api_key)),
        #[cfg(feature = "provider-copilot")]
        "github-copilot" | "copilot" => {
            if let Ok(p) = crate::providers::copilot::CopilotProvider::from_openclaw() {
                Arc::new(p)
            } else {
                Arc::new(crate::providers::copilot::CopilotProvider::new(&api_key))
            }
        }
        #[cfg(feature = "rs-ai")]
        "gemini" => Arc::new(crate::providers::rs_ai::RsAiProvider::new(
            "gemini",
            &cfg.model,
            &api_key,
            cfg.provider.base_url.clone(),
            None,
        )),
        #[cfg(feature = "rs-ai")]
        "xai" | "grok" => Arc::new(crate::providers::rs_ai::RsAiProvider::new(
            "xai",
            &cfg.model,
            &api_key,
            cfg.provider.base_url.clone(),
            None,
        )),
        #[cfg(feature = "rs-ai")]
        "cloudflare" => Arc::new(crate::providers::rs_ai::RsAiProvider::new(
            "cloudflare",
            &cfg.model,
            &api_key,
            None,
            cfg.provider.base_url.clone(),
        )),
        "ollama" => {
            #[cfg(feature = "provider-ollama")]
            {
                let url = cfg
                    .provider
                    .base_url
                    .clone()
                    .unwrap_or_else(|| "http://localhost:11434".into());
                Arc::new(OllamaProvider::new(url))
            }
            #[cfg(not(feature = "provider-ollama"))]
            {
                panic!("provider=ollama requires building with the provider-ollama feature");
            }
        }
        "openai" => Arc::new(OpenAiCompatProvider::openai(&api_key)),
        "openrouter" => Arc::new(OpenAiCompatProvider::openrouter(&api_key)),
        "groq" => Arc::new(OpenAiCompatProvider::groq(&api_key)),
        "together" => Arc::new(OpenAiCompatProvider::together(&api_key)),
        "mistral" => Arc::new(OpenAiCompatProvider::mistral(&api_key)),
        "deepseek" => Arc::new(OpenAiCompatProvider::deepseek(&api_key)),
        "fireworks" => Arc::new(OpenAiCompatProvider::fireworks(&api_key)),
        "perplexity" => Arc::new(OpenAiCompatProvider::perplexity(&api_key)),
        #[cfg(not(feature = "rs-ai"))]
        "xai" | "grok" => Arc::new(OpenAiCompatProvider::xai(&api_key)),
        "moonshot" | "kimi" => Arc::new(OpenAiCompatProvider::moonshot(&api_key)),
        "venice" => Arc::new(OpenAiCompatProvider::venice(&api_key)),
        "huggingface" => Arc::new(OpenAiCompatProvider::huggingface(&api_key)),
        "siliconflow" => Arc::new(OpenAiCompatProvider::siliconflow(&api_key)),
        "cerebras" => Arc::new(OpenAiCompatProvider::cerebras(&api_key)),
        "minimax" => Arc::new(OpenAiCompatProvider::minimax(&api_key)),
        "vercel" => Arc::new(OpenAiCompatProvider::vercel(&api_key)),
        other => {
            let url = cfg
                .provider
                .base_url
                .clone()
                .unwrap_or_else(|| "https://api.openai.com/v1".into());
            Arc::new(OpenAiCompatProvider::new(&api_key, url, other))
        }
    }
}

pub fn build_base_tools(
    workspace: &Path,
    policy: Arc<ExecutionPolicy>,
    memory: Arc<dyn MemoryBackend>,
    embedding_provider: Option<Arc<dyn EmbeddingProvider>>,
    provider: Arc<dyn Provider>,
    cfg: &Config,
    #[cfg(feature = "zkr-memory")] zkr_store: Option<Arc<crate::memory::zkr::ZkrStore>>,
) -> Vec<Arc<dyn Tool>> {
    let toolsets = &cfg.toolsets;
    let mut tools: Vec<Arc<dyn Tool>> = vec![
        Arc::new(ShellTool::new(workspace.to_path_buf(), Arc::clone(&policy))),
        Arc::new(FileReadTool::new(workspace.to_path_buf())),
        Arc::new(FileWriteTool::new(workspace.to_path_buf())),
        Arc::new(crate::tools::edit::EditTool::new(workspace.to_path_buf())),
        Arc::new(MemorySearchTool::new(workspace.to_path_buf())),
        Arc::new(MemoryGetTool::new(workspace.to_path_buf())),
        Arc::new(SessionSearchTool::new(Arc::clone(&memory))),
        Arc::new(crate::tools::doctor::DoctorTool::new()),
        Arc::new(BuildRunnerTool::with_default_config(
            workspace.to_path_buf(),
            Arc::clone(&policy),
        )),
        Arc::new(crate::tools::dynamic::CreateToolTool::new(Arc::clone(
            &policy,
        ))),
        Arc::new(crate::tools::dynamic::ListCustomToolsTool::new()),
        Arc::new(BriefTool::new(
            Arc::clone(&provider),
            cfg.agent.fast_model.clone(),
        )),
        Arc::new(ConfigTool::new(workspace.join("apollo.json"))),
        Arc::new(SleepTool),
        Arc::new(TodoWriteTool::new(workspace.to_path_buf())),
        Arc::new(crate::tools::TelekinesisTool::new(
            workspace.to_path_buf(),
            Arc::clone(&policy),
        )),
    ];
    #[cfg(feature = "plugin-web")]
    {
        // A provider that searches server-side already answers to the name
        // `web_search`. Registering apollo's tool too would send the model two
        // tools with one name, which the API rejects outright.
        if !provider.capabilities().native_web_search {
            tools.push(Arc::new(crate::tools::web_search::WebSearchTool::new()));
        }
        tools.push(Arc::new(crate::tools::web_fetch::WebFetchTool::new()));
    }
    #[cfg(feature = "plugin-browser")]
    tools.push(Arc::new(crate::tools::browser::BrowserTool::new()));
    #[cfg(feature = "plugin-advanced")]
    {
        tools.push(Arc::new(crate::tools::mcp::McpTool::new()));
        tools.push(Arc::new(VibemaniaTool::new(workspace.to_path_buf())));
        tools.push(Arc::new(WorktreeTool::new(workspace.to_path_buf())));
    }
    #[cfg(feature = "plugin-skills")]
    tools.push(Arc::new(SkillManagerTool::new(workspace.to_path_buf())));
    if let Some(provider) = embedding_provider {
        tools.push(Arc::new(EmbeddingStatusTool::new(Arc::clone(&provider))));
        tools.push(Arc::new(EmbeddingStoreTool::new(
            Arc::clone(&provider),
            Arc::clone(&memory),
        )));
        tools.push(Arc::new(EmbeddingSearchTool::new(provider, memory)));
    }
    #[cfg(feature = "computer-use-praefectus")]
    match crate::tools::praefectus::PraefectusTool::new(workspace, Arc::clone(&policy)) {
        Ok(tool) => tools.push(Arc::new(tool)),
        Err(error) => tracing::error!("failed to initialize Praefectus: {error}"),
    }
    #[cfg(feature = "zkr-memory")]
    if let Some(store) = zkr_store {
        tools.push(Arc::new(crate::tools::zkr::ZkrTool::new(store)));
    }
    #[cfg(feature = "rs-ai")]
    {
        let media_key = cfg.provider.api_key.clone().unwrap_or_default();
        let media_provider = cfg.provider.name.clone();
        tools.push(Arc::new(crate::tools::media::ImageGenerationTool::new(
            workspace.to_path_buf(),
            media_key.clone(),
            media_provider.clone(),
        )));
        tools.push(Arc::new(crate::tools::media::TextToSpeechTool::new(
            workspace.to_path_buf(),
            media_key.clone(),
            media_provider.clone(),
        )));
        tools.push(Arc::new(crate::tools::media::SpeechToTextTool::new(
            media_key,
            media_provider,
        )));
    }
    tools
        .into_iter()
        .filter(|tool| is_tool_enabled(tool.name(), toolsets))
        .collect()
}

pub fn build_embedding_provider(
    cfg: &Config,
) -> anyhow::Result<Option<Arc<dyn EmbeddingProvider>>> {
    if !cfg.embeddings.enabled {
        return Ok(None);
    }

    let provider_name = cfg.embeddings.provider.trim().to_ascii_lowercase();
    let model = cfg.embeddings.model.clone();
    let base_url = cfg.embeddings.base_url.clone();
    let api_key = cfg.embeddings.api_key.clone();

    let provider = create_embedding_provider(&provider_name, api_key, model, base_url)?;
    Ok(Some(provider))
}

#[cfg(feature = "zkr-memory")]
pub fn build_zkr_store(
    workspace: &Path,
    cfg: &Config,
) -> anyhow::Result<Option<Arc<crate::memory::zkr::ZkrStore>>> {
    if !cfg.zkr.enabled {
        return Ok(None);
    }
    let person_id = cfg
        .memory
        .principal_id
        .as_deref()
        .unwrap_or(&cfg.zkr.person_id);
    Ok(Some(Arc::new(crate::memory::zkr::ZkrStore::open(
        &workspace.join(&cfg.zkr.database),
        cfg.zkr.tenant_id.clone(),
        person_id.to_string(),
    )?)))
}

pub async fn build_memory_backend(
    workspace: &Path,
    cfg: &Config,
) -> anyhow::Result<Arc<dyn MemoryBackend>> {
    let storage_root = workspace.join(&cfg.storage.root);
    std::fs::create_dir_all(&storage_root)?;
    let backend = cfg.storage.backend.trim().to_ascii_lowercase();
    if backend != "surreal" {
        anyhow::bail!(
            "storage.backend={} is not supported; only surreal is available",
            cfg.storage.backend
        );
    }

    let surreal_path = storage_root.join("memory.surreal");
    let memory = SurrealMemory::new(surreal_path.as_path()).await?;

    let warmup = memory.clone();
    tokio::spawn(async move {
        if let Err(e) = warmup.db().await {
            tracing::error!("memory backend failed to open: {e:#}");
        }
    });

    Ok(Arc::new(memory))
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn require_config_file_errors_when_missing() {
        let path = "/tmp/apollo-bootstrap-missing-config-test-xyz123.json";
        let err = require_config_file(path).unwrap_err();
        assert!(err.to_string().contains("Config not found"));
        assert!(err.to_string().contains(path));
    }

    #[test]
    fn require_config_file_ok_when_present() {
        let dir = tempfile::tempdir().unwrap();
        let path = dir.path().join("apollo.json");
        std::fs::write(&path, "{}").unwrap();
        require_config_file(path.to_str().unwrap()).unwrap();
    }
}

#[cfg(test)]
mod default_model_tests {
    use super::*;

    fn config_with(provider: &str, model: &str) -> Config {
        let mut cfg = Config::default_config();
        cfg.provider.name = provider.to_string();
        cfg.model = model.to_string();
        cfg
    }

    #[test]
    fn a_blank_model_is_filled_from_the_provider() {
        let mut cfg = config_with("xai", "");
        apply_default_model(&mut cfg);
        assert_eq!(cfg.model, "grok-build-0.1");

        let mut cfg = config_with("chatgpt", "");
        apply_default_model(&mut cfg);
        assert_eq!(cfg.model, "gpt-5.5");
    }

    #[test]
    fn a_configured_model_is_never_replaced() {
        // Regression: credential detection used to overwrite the model even
        // when the config named one, so an OAuth user lost their choice.
        let mut cfg = config_with("chatgpt", "gpt-5.4-mini");
        apply_default_model(&mut cfg);
        assert_eq!(cfg.model, "gpt-5.4-mini");
    }

    #[test]
    fn whitespace_counts_as_unset() {
        let mut cfg = config_with("chatgpt", "   ");
        apply_default_model(&mut cfg);
        assert_eq!(cfg.model, "gpt-5.5");
    }

    #[test]
    fn an_unknown_provider_leaves_the_model_alone() {
        let mut cfg = config_with("some-private-gateway", "");
        apply_default_model(&mut cfg);
        assert!(cfg.model.is_empty(), "must not invent a model id");
    }
}