ralph-workflow 0.7.18

PROMPT-driven multi-agent orchestrator for git repos
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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
//! `OpenCode` agent resolver for dynamic provider/model configuration.
//!
//! This module provides dynamic agent resolution for `OpenCode` using the syntax
//! `opencode/provider/model` (e.g., `opencode/anthropic/claude-sonnet-4-5`).
//!
//! The resolver validates provider/model combinations against the `OpenCode` API
//! catalog and generates `AgentConfig` instances on-the-fly with the appropriate
//! command-line flags.
//!
//! # Usage
//!
//! ```ignore
//! // In agent chain configuration:
//! [agent_chains]
//! developer = ["opencode/anthropic/claude-sonnet-4-5", "claude"]
//!
//! [agent_drains]
//! planning = "developer"
//! development = "developer"
//! ```
//!
//! # Supported Patterns
//!
//! - `opencode/provider/model` - Dynamic provider/model from API catalog
//! - `opencode` - Base `OpenCode` agent (uses default or user-specified provider/model)

use crate::agents::config::AgentConfig;
use crate::agents::opencode_api::ApiCatalog;
use crate::agents::parser::JsonParserType;
use itertools::Itertools;
use strsim::levenshtein;

/// Maximum Levenshtein distance for typo suggestions.
///
/// Strings with edit distance <= this value are considered potential typos.
const MAX_TYPO_DISTANCE: usize = 3;

/// `OpenCode` agent resolver for dynamic provider/model configuration.
///
/// Validates provider/model combinations against the `OpenCode` API catalog
/// and generates `AgentConfig` instances with the appropriate command-line flags.
#[derive(Debug)]
pub struct OpenCodeResolver {
    /// `OpenCode` API catalog with available providers and models.
    catalog: ApiCatalog,
}

impl OpenCodeResolver {
    /// Create a new `OpenCode` resolver with the given API catalog.
    pub const fn new(catalog: ApiCatalog) -> Self {
        Self { catalog }
    }

    /// Try to resolve an agent name to an `AgentConfig`.
    ///
    /// Supports the following patterns:
    /// - `opencode` - Plain `OpenCode` agent (uses `OpenCode`'s default model)
    /// - `opencode/provider/model` - Dynamic provider/model from API catalog
    ///
    /// Returns `None` if the name doesn't match the `OpenCode` pattern or if
    /// the provider/model combination is not found in the catalog.
    pub fn try_resolve(&self, name: &str) -> Option<AgentConfig> {
        // Handle plain "opencode" - use default (no model flag)
        if name == "opencode" {
            return Some(Self::build_default_config());
        }

        // Check if it starts with "opencode/"
        if !name.starts_with("opencode/") {
            return None;
        }

        // Parse the pattern: "opencode/provider/model"
        let parts: Vec<&str> = name.split('/').collect();
        if parts.len() != 3 {
            return None;
        }

        let provider = parts.get(1)?;
        let model = parts.get(2)?;

        // Validate provider and model exist in catalog
        if !self.catalog.has_provider(provider) {
            return None;
        }
        if !self.catalog.has_model(provider, model) {
            return None;
        }

        // Build the agent config
        Some(Self::build_config(provider, model))
    }

    /// Build an `AgentConfig` for the given provider/model.
    fn build_config(provider: &str, model: &str) -> AgentConfig {
        // OpenCode command syntax: opencode run -m provider/model
        // The model_flag is the "-m provider/model" part
        let model_flag = format!("-m {provider}/{model}");

        // Set OPENCODE_PERMISSION to allow all tool actions without prompting
        // This is required for non-interactive/headless execution
        // The value must be a JSON object where keys are permission types and values are actions
        // Using {"*": "allow"} grants all permissions for all patterns
        let env_vars = std::collections::HashMap::from([(
            "OPENCODE_PERMISSION".to_string(),
            r#"{"*": "allow"}"#.to_string(),
        )]);

        AgentConfig {
            cmd: "opencode run".to_string(),
            output_flag: "--format json".to_string(),
            // OpenCode doesn't have a CLI yolo flag - permissions are controlled
            // via OPENCODE_PERMISSION environment variable (set above)
            yolo_flag: String::new(),
            verbose_flag: "--log-level DEBUG --print-logs".to_string(),
            can_commit: true,
            json_parser: JsonParserType::OpenCode,
            model_flag: Some(model_flag),
            print_flag: String::new(),
            streaming_flag: String::new(),
            // Session continuation: -s <session_id> (from `opencode run --help`)
            // Allows XSD retries to continue the same conversation so AI retains memory
            session_flag: "-s {}".to_string(),
            env_vars,
            display_name: Some(format!("OpenCode ({provider})")),
        }
    }

    /// Build an `AgentConfig` for plain "opencode" (no provider/model specified).
    /// `OpenCode` will use its default model configuration.
    fn build_default_config() -> AgentConfig {
        let env_vars = std::collections::HashMap::from([(
            "OPENCODE_PERMISSION".to_string(),
            r#"{"*": "allow"}"#.to_string(),
        )]);

        AgentConfig {
            cmd: "opencode run".to_string(),
            output_flag: "--format json".to_string(),
            // OpenCode doesn't have a CLI yolo flag - permissions are controlled
            // via OPENCODE_PERMISSION environment variable (set above)
            yolo_flag: String::new(),
            verbose_flag: "--log-level DEBUG --print-logs".to_string(),
            can_commit: true,
            json_parser: JsonParserType::OpenCode,
            model_flag: None,
            print_flag: String::new(),
            streaming_flag: String::new(),
            // Session continuation: -s <session_id> (from `opencode run --help`)
            // Allows XSD retries to continue the same conversation so AI retains memory
            session_flag: "-s {}".to_string(),
            env_vars,
            display_name: Some("OpenCode".to_string()),
        }
    }

    /// Validate a provider/model combination.
    ///
    /// Returns an error if the provider or model doesn't exist in the catalog.
    pub fn validate(&self, provider: &str, model: &str) -> Result<(), ValidationError> {
        if !self.catalog.has_provider(provider) {
            return Err(ValidationError::ProviderNotFound {
                provider: provider.to_string(),
                suggestions: self.suggest_providers(provider),
            });
        }

        if !self.catalog.has_model(provider, model) {
            return Err(ValidationError::ModelNotFound {
                provider: provider.to_string(),
                model: model.to_string(),
                suggestions: self.suggest_models(provider, model),
            });
        }

        Ok(())
    }

    /// Suggest similar provider names for a typo.
    fn suggest_providers(&self, provider: &str) -> Vec<String> {
        self.catalog
            .provider_names()
            .into_iter()
            .map(|p| {
                let distance = levenshtein(provider, &p);
                (p, distance)
            })
            .filter(|(_, d)| *d <= MAX_TYPO_DISTANCE)
            .sorted_by_key(|(_, d)| *d)
            .take(MAX_TYPO_DISTANCE)
            .map(|(p, _)| p)
            .collect()
    }

    /// Suggest similar model names for a typo.
    fn suggest_models(&self, provider: &str, model: &str) -> Vec<String> {
        self.catalog
            .get_model_ids(provider)
            .into_iter()
            .map(|m| {
                let distance = levenshtein(model, &m);
                (m, distance)
            })
            .filter(|(_, d)| *d <= MAX_TYPO_DISTANCE)
            .sorted_by_key(|(_, d)| *d)
            .take(MAX_TYPO_DISTANCE)
            .map(|(m, _)| m)
            .collect()
    }

    /// Get a user-friendly error message for a validation error.
    pub fn format_error(&self, error: &ValidationError, agent_name: &str) -> String {
        match error {
            ValidationError::ProviderNotFound {
                provider,
                suggestions,
            } => {
                let msg =
                    format!("Error: OpenCode provider '{provider}' not found in API catalog.\n");
                let msg = if let Some(closest) = suggestions.first() {
                    format!("{msg}Did you mean: {closest}?\n")
                } else {
                    msg
                };
                let msg = format!("{msg}Agent reference: {agent_name}");
                let available = self.catalog.provider_names().join(", ");
                format!(
                    "{msg}\nAvailable providers: {available}\n\nPlease update your agent configuration."
                )
            }
            ValidationError::ModelNotFound {
                provider,
                model,
                suggestions,
            } => {
                let msg = format!(
                    "Error: OpenCode model '{provider}/{model}' not found in API catalog.\n"
                );
                let msg = if let Some(closest) = suggestions.first() {
                    format!("{msg}Did you mean: {provider}/{closest}?\n")
                } else {
                    msg
                };
                let msg = format!("{msg}Agent reference: {agent_name}\n");
                let available = self.catalog.get_model_ids(provider).join(", ");
                format!(
                    "{msg}Available models for '{provider}': {available}\n\nPlease update your agent configuration."
                )
            }
        }
    }
}

/// Errors that can occur during `OpenCode` agent validation.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ValidationError {
    /// Provider not found in the API catalog.
    ProviderNotFound {
        provider: String,
        suggestions: Vec<String>,
    },
    /// Model not found for the given provider.
    ModelNotFound {
        provider: String,
        model: String,
        suggestions: Vec<String>,
    },
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::agents::opencode_api::{Model, Provider};
    use std::collections::HashMap;

    fn mock_api_catalog() -> ApiCatalog {
        let providers = HashMap::from([
            (
                "anthropic".to_string(),
                Provider {
                    id: "anthropic".to_string(),
                    name: "Anthropic".to_string(),
                    description: "Anthropic Claude models".to_string(),
                },
            ),
            (
                "openai".to_string(),
                Provider {
                    id: "openai".to_string(),
                    name: "OpenAI".to_string(),
                    description: "OpenAI GPT models".to_string(),
                },
            ),
        ]);

        let models = HashMap::from([
            (
                "anthropic".to_string(),
                vec![
                    Model {
                        id: "claude-sonnet-4-5".to_string(),
                        name: "Claude Sonnet 4.5".to_string(),
                        description: "Latest Claude Sonnet".to_string(),
                        context_length: Some(200_000),
                    },
                    Model {
                        id: "claude-opus-4".to_string(),
                        name: "Claude Opus 4".to_string(),
                        description: "Most capable Claude".to_string(),
                        context_length: Some(200_000),
                    },
                ],
            ),
            (
                "openai".to_string(),
                vec![Model {
                    id: "gpt-4".to_string(),
                    name: "GPT-4".to_string(),
                    description: "OpenAI's GPT-4".to_string(),
                    context_length: Some(8192),
                }],
            ),
        ]);

        ApiCatalog {
            providers,
            models,
            cached_at: Some(chrono::Utc::now()),
            ttl_seconds: 86400,
        }
    }

    #[test]
    fn test_try_resolve_valid_pattern() {
        let catalog = mock_api_catalog();
        let resolver = OpenCodeResolver::new(catalog);

        let config = resolver.try_resolve("opencode/anthropic/claude-sonnet-4-5");
        assert!(config.is_some());

        let config = config.unwrap();
        assert_eq!(config.cmd, "opencode run");
        assert_eq!(
            config.model_flag,
            Some("-m anthropic/claude-sonnet-4-5".to_string())
        );
        assert_eq!(config.json_parser, JsonParserType::OpenCode);
    }

    #[test]
    fn test_try_resolve_plain_opencode() {
        let catalog = mock_api_catalog();
        let resolver = OpenCodeResolver::new(catalog);

        let config = resolver.try_resolve("opencode");
        assert!(config.is_some());

        let config = config.unwrap();
        assert_eq!(config.cmd, "opencode run");
        assert_eq!(config.model_flag, None); // No model flag for default
        assert_eq!(config.json_parser, JsonParserType::OpenCode);
        assert_eq!(
            config.env_vars.get("OPENCODE_PERMISSION"),
            Some(&r#"{"*": "allow"}"#.to_string())
        );
        assert_eq!(config.display_name, Some("OpenCode".to_string()));
    }

    #[test]
    fn test_try_resolve_invalid_pattern() {
        let catalog = mock_api_catalog();
        let resolver = OpenCodeResolver::new(catalog);

        // Not an opencode pattern
        assert!(resolver.try_resolve("claude").is_none());
        assert!(resolver.try_resolve("ccs/glm").is_none());

        // Malformed opencode pattern (missing model)
        assert!(resolver.try_resolve("opencode/anthropic").is_none());

        // Unknown provider
        assert!(resolver.try_resolve("opencode/unknown/model").is_none());

        // Unknown model
        assert!(resolver
            .try_resolve("opencode/anthropic/unknown-model")
            .is_none());
    }

    #[test]
    fn test_validate_valid_provider_model() {
        let catalog = mock_api_catalog();
        let resolver = OpenCodeResolver::new(catalog);

        assert!(resolver.validate("anthropic", "claude-sonnet-4-5").is_ok());
        assert!(resolver.validate("openai", "gpt-4").is_ok());
    }

    #[test]
    fn test_validate_invalid_provider() {
        let catalog = mock_api_catalog();
        let resolver = OpenCodeResolver::new(catalog);

        let result = resolver.validate("unknown", "model");
        assert!(result.is_err());

        if let Err(ValidationError::ProviderNotFound { provider, .. }) = result {
            assert_eq!(provider, "unknown");
        } else {
            panic!("Expected ProviderNotFound error");
        }
    }

    #[test]
    fn test_validate_invalid_model() {
        let catalog = mock_api_catalog();
        let resolver = OpenCodeResolver::new(catalog);

        let result = resolver.validate("anthropic", "unknown-model");
        assert!(result.is_err());

        if let Err(ValidationError::ModelNotFound { model, .. }) = result {
            assert_eq!(model, "unknown-model");
        } else {
            panic!("Expected ModelNotFound error");
        }
    }

    #[test]
    fn test_build_config() {
        let catalog = mock_api_catalog();
        let _resolver = OpenCodeResolver::new(catalog);

        let config = OpenCodeResolver::build_config("anthropic", "claude-sonnet-4-5");

        assert_eq!(config.cmd, "opencode run");
        assert_eq!(
            config.model_flag,
            Some("-m anthropic/claude-sonnet-4-5".to_string())
        );
        assert_eq!(config.output_flag, "--format json");
        // OpenCode doesn't have a CLI yolo flag - permissions via OPENCODE_PERMISSION env var
        assert_eq!(config.yolo_flag, "");
        assert_eq!(config.json_parser, JsonParserType::OpenCode);
        assert!(config.can_commit);
        // Verify OPENCODE_PERMISSION is set for non-interactive mode
        // The value is a JSON object that grants all permissions
        assert_eq!(
            config.env_vars.get("OPENCODE_PERMISSION"),
            Some(&r#"{"*": "allow"}"#.to_string())
        );
    }

    #[test]
    fn test_format_error_provider_not_found() {
        let catalog = mock_api_catalog();
        let resolver = OpenCodeResolver::new(catalog);

        let error = ValidationError::ProviderNotFound {
            provider: "antrhopic".to_string(),
            suggestions: vec!["anthropic".to_string()],
        };

        let msg = resolver.format_error(&error, "opencode/antrhopic/claude-sonnet-4-5");

        assert!(msg.contains("antrhopic"));
        assert!(msg.contains("anthropic"));
        assert!(msg.contains("opencode/antrhopic/claude-sonnet-4-5"));
        assert!(msg.contains("Available providers"));
    }

    #[test]
    fn test_format_error_model_not_found() {
        let catalog = mock_api_catalog();
        let resolver = OpenCodeResolver::new(catalog);

        let error = ValidationError::ModelNotFound {
            provider: "anthropic".to_string(),
            model: "claude-sonnet-4".to_string(),
            suggestions: vec!["claude-sonnet-4-5".to_string()],
        };

        let msg = resolver.format_error(&error, "opencode/anthropic/claude-sonnet-4");

        assert!(msg.contains("anthropic/claude-sonnet-4"));
        assert!(msg.contains("claude-sonnet-4-5"));
        assert!(msg.contains("Available models"));
    }
}