visual-rubric 0.2.0

AI-assisted screenshot rubric runner for local visual UX review
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
490
491
492
//! `configured` subcommand — applies the rubric using a TOML config file
//! written by the Home Manager module.
//!
//! The default config path is `~/.config/visual-rubric/config.toml`.
//! CLI flags override individual TOML fields for one-off testing.

use std::path::PathBuf;

use anyhow::{Context as _, Result, anyhow};
use clap::ValueEnum;
use serde::Deserialize;

use crate::vision::VisionApiConfig;

use super::QuestionSource;

const DEFAULT_CONFIG_PATH: &str = "visual-rubric/config.toml";
const DEFAULT_DIRECT_MODEL: &str = "gpt-5.5";
const DEFAULT_DIRECT_EFFORT: &str = "medium";
const DEFAULT_PIPELINE_VISION_MODEL: &str = "qwen3-vl-8b";

/// Arguments for the `configured` subcommand.
#[derive(Clone, Debug, clap::Parser)]
pub struct ConfiguredArgs {
    /// PNG screenshot path.
    #[arg(long)]
    pub image: PathBuf,

    /// Rubric question (required if --preset is not set).
    #[command(flatten)]
    pub questions: QuestionSource,

    /// Asset name for assertion messages.
    #[arg(long, default_value = "screenshot")]
    pub name: String,

    /// Output verdict as JSON.
    #[arg(long)]
    pub json: bool,

    /// TOML config path (default: ~/.config/visual-rubric/config.toml).
    #[arg(long)]
    pub config: Option<PathBuf>,

    // --- CLI overrides (fall back to TOML, then built-in defaults) ---
    /// Backend mode: direct codex-acp image evaluation or two-stage pipeline.
    #[arg(long, value_enum)]
    pub mode: Option<ConfiguredMode>,

    /// Vision API base URL.
    #[arg(long)]
    pub vision_url: Option<String>,

    /// Vision model name.
    #[arg(long)]
    pub vision_model: Option<String>,

    /// Vision API key (Bearer token).
    #[arg(long)]
    pub vision_api_key: Option<String>,

    /// Custom prompt for the vision extraction stage.
    #[arg(long)]
    pub vision_prompt: Option<String>,

    /// ACP binary path (opencode or codex-acp).
    #[arg(long)]
    pub acp_binary: Option<String>,

    /// Extra CLI arguments for the ACP binary. May be repeated.
    #[arg(long = "acp-arg")]
    pub acp_args: Vec<String>,

    /// Rubric model name (passed to codex-acp; ignored for opencode).
    #[arg(long)]
    pub model: Option<String>,

    /// Rubric reasoning effort.
    #[arg(long)]
    pub effort: Option<String>,

    /// Rubric system prompt override.
    #[arg(long)]
    pub system_prompt: Option<String>,
}

/// Configured backend mode.
#[derive(Clone, Copy, Debug, Default, Deserialize, PartialEq, Eq, ValueEnum)]
#[serde(rename_all = "kebab-case")]
pub enum ConfiguredMode {
    /// Direct screenshot evaluation through codex-acp.
    Direct,
    /// Qwen3-VL vision extraction followed by ACP rubric scoring.
    #[default]
    Pipeline,
}

/// TOML config shape written by the HM module.
#[derive(Debug, Deserialize, Default)]
#[serde(default)]
struct TomlConfig {
    mode: Option<ConfiguredMode>,
    vision: TomlVision,
    rubric: TomlRubric,
}

#[derive(Debug, Deserialize, Default)]
#[serde(default)]
struct TomlVision {
    url: Option<String>,
    model: Option<String>,
    api_key: Option<String>,
    prompt: Option<String>,
}

#[derive(Debug, Deserialize, Default)]
#[serde(default)]
struct TomlRubric {
    backend: Option<String>,
    args: Option<Vec<String>>,
    model: Option<String>,
    effort: Option<String>,
    system_prompt: Option<String>,
}

/// Runs the configured pipeline using TOML config + CLI overrides.
///
/// # Errors
///
/// Returns errors from the vision API, ACP, or verdict parsing.
pub fn run_configured(args: ConfiguredArgs) -> Result<()> {
    let question = args.questions.resolve().map_err(|e| anyhow!(e))?;
    let toml = load_config(args.config.as_deref())?;
    let mode = args.mode.or(toml.mode).unwrap_or_default();

    let system_prompt = match args.system_prompt.or(toml.rubric.system_prompt) {
        Some(prompt) => Some(prompt),
        None => args
            .questions
            .resolve_system_prompt()
            .map_err(|e| anyhow!(e))?,
    };
    let rubric_options = rubric_options_for_mode(
        mode,
        args.model,
        toml.rubric.model,
        args.effort,
        toml.rubric.effort,
        system_prompt,
    );

    let verdict = match mode {
        ConfiguredMode::Direct => {
            let rubric_config = direct_rubric_config(args.acp_binary, toml.rubric.backend);
            crate::evaluate_image_rubric_with_config(
                &args.image,
                &question,
                rubric_options,
                rubric_config,
            )
            .with_context(|| format!("direct rubric for {} failed", args.image.display()))?
        }
        ConfiguredMode::Pipeline => {
            let vision_url = args
                .vision_url
                .or(toml.vision.url)
                .context("vision URL is not set. Set it in config.toml or pass --vision-url")?;

            let vision_model = args
                .vision_model
                .or(toml.vision.model)
                .unwrap_or_else(|| DEFAULT_PIPELINE_VISION_MODEL.to_string());

            let vision_config = VisionApiConfig {
                url: vision_url,
                model: vision_model,
                api_key: args.vision_api_key.or(toml.vision.api_key),
            };

            let vision_prompt = args
                .vision_prompt
                .or(toml.vision.prompt)
                .unwrap_or_else(|| crate::DEFAULT_VISION_PROMPT.to_string());

            let acp_args = if !args.acp_args.is_empty() {
                args.acp_args
            } else if let Some(toml_args) = &toml.rubric.args {
                toml_args.clone()
            } else {
                vec!["acp".to_string()]
            };

            let acp_binary = args
                .acp_binary
                .or(toml.rubric.backend)
                .unwrap_or_else(|| "opencode".to_string());

            let rubric_config = crate::RubricRunConfig {
                codex_acp_binary: acp_binary.into(),
                acp_args,
                extra_env: Vec::new(),
                cwd: None,
            };

            crate::evaluate_image_rubric_pipeline(
                &args.image,
                &question,
                &vision_config,
                &vision_prompt,
                &rubric_options,
                &rubric_config,
            )
            .with_context(|| format!("pipeline for {} failed", args.image.display()))?
        }
    };

    if args.json {
        println!("{}", serde_json::to_string(&verdict)?);
        return Ok(());
    }

    crate::assert_verdict(&args.name, verdict)
        .map(|()| println!("visual rubric passed"))
        .map_err(|error| anyhow::anyhow!(error))
}

fn rubric_options_for_mode(
    mode: ConfiguredMode,
    cli_model: Option<String>,
    toml_model: Option<String>,
    cli_effort: Option<String>,
    toml_effort: Option<String>,
    system_prompt: Option<String>,
) -> crate::RubricOptions {
    let (default_model, default_effort) = match mode {
        ConfiguredMode::Direct => (Some(DEFAULT_DIRECT_MODEL), Some(DEFAULT_DIRECT_EFFORT)),
        ConfiguredMode::Pipeline => (None, None),
    };
    crate::RubricOptions {
        model: cli_model
            .or(toml_model)
            .or_else(|| default_model.map(str::to_string)),
        effort: cli_effort
            .or(toml_effort)
            .or_else(|| default_effort.map(str::to_string))
            .map(Into::into),
        system_prompt,
    }
}

fn direct_rubric_config(
    cli_binary: Option<String>,
    toml_binary: Option<String>,
) -> crate::RubricRunConfig {
    crate::RubricRunConfig {
        codex_acp_binary: cli_binary
            .or(toml_binary)
            .unwrap_or_else(|| "codex-acp".to_string())
            .into(),
        acp_args: Vec::new(),
        extra_env: Vec::new(),
        cwd: None,
    }
}

fn load_config(cli_path: Option<&std::path::Path>) -> Result<TomlConfig> {
    let path = match cli_path {
        Some(p) => p.to_path_buf(),
        None => match dirs_config_dir() {
            Some(base) => base.join(DEFAULT_CONFIG_PATH),
            None => return Ok(TomlConfig::default()),
        },
    };

    let content = match std::fs::read_to_string(&path) {
        Ok(c) => c,
        Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(TomlConfig::default()),
        Err(e) => return Err(e).context(format!("read config {}", path.display())),
    };

    toml::from_str(&content).context(format!("parse config {}", path.display()))
}

fn dirs_config_dir() -> Option<PathBuf> {
    #[cfg(target_os = "linux")]
    {
        std::env::var("XDG_CONFIG_HOME")
            .ok()
            .map(PathBuf::from)
            .or_else(|| {
                std::env::var("HOME")
                    .ok()
                    .map(|h| PathBuf::from(h).join(".config"))
            })
    }
    #[cfg(not(target_os = "linux"))]
    {
        dirs::config_dir()
    }
}

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

    #[test]
    fn parses_direct_mode_without_vision_config() {
        let config: TomlConfig = toml::from_str(
            r#"
mode = "direct"

[rubric]
backend = "codex-acp"
"#,
        )
        .unwrap();

        assert_eq!(config.mode, Some(ConfiguredMode::Direct));
        assert!(config.vision.url.is_none());
    }

    #[test]
    fn direct_mode_defaults_to_gpt55_medium_codex_acp() {
        let options = rubric_options_for_mode(ConfiguredMode::Direct, None, None, None, None, None);
        let config = direct_rubric_config(None, None);

        assert_eq!(options.model.as_deref(), Some("gpt-5.5"));
        assert_eq!(options.effort.as_deref(), Some("medium"));
        assert_eq!(config.codex_acp_binary, PathBuf::from("codex-acp"));
        assert!(config.acp_args.is_empty());
    }

    #[test]
    fn pipeline_mode_does_not_add_direct_model_defaults() {
        let options =
            rubric_options_for_mode(ConfiguredMode::Pipeline, None, None, None, None, None);

        assert!(options.model.is_none());
        assert!(options.effort.is_none());
    }

    #[test]
    fn rubric_options_prefer_cli_then_toml_then_direct_defaults() {
        let options = rubric_options_for_mode(
            ConfiguredMode::Direct,
            Some("cli-model".to_string()),
            Some("toml-model".to_string()),
            Some("high".to_string()),
            Some("low".to_string()),
            Some("Use the exact rubric.".to_string()),
        );

        assert_eq!(options.model.as_deref(), Some("cli-model"));
        assert_eq!(options.effort.as_deref(), Some("high"));
        assert_eq!(
            options.system_prompt.as_deref(),
            Some("Use the exact rubric.")
        );

        let options = rubric_options_for_mode(
            ConfiguredMode::Direct,
            None,
            Some("toml-model".to_string()),
            None,
            Some("low".to_string()),
            None,
        );

        assert_eq!(options.model.as_deref(), Some("toml-model"));
        assert_eq!(options.effort.as_deref(), Some("low"));
    }

    #[test]
    fn pipeline_options_use_cli_or_toml_without_direct_defaults() {
        let options = rubric_options_for_mode(
            ConfiguredMode::Pipeline,
            None,
            Some("rubric-model".to_string()),
            None,
            Some("medium".to_string()),
            None,
        );

        assert_eq!(options.model.as_deref(), Some("rubric-model"));
        assert_eq!(options.effort.as_deref(), Some("medium"));

        let options = rubric_options_for_mode(
            ConfiguredMode::Pipeline,
            Some("cli-model".to_string()),
            Some("toml-model".to_string()),
            Some("high".to_string()),
            Some("low".to_string()),
            None,
        );

        assert_eq!(options.model.as_deref(), Some("cli-model"));
        assert_eq!(options.effort.as_deref(), Some("high"));
    }

    #[test]
    fn direct_rubric_config_prefers_cli_then_toml_then_default() {
        let config = direct_rubric_config(
            Some("cli-codex-acp".to_string()),
            Some("toml-codex-acp".to_string()),
        );
        assert_eq!(config.codex_acp_binary, PathBuf::from("cli-codex-acp"));
        assert!(config.acp_args.is_empty());

        let config = direct_rubric_config(None, Some("toml-codex-acp".to_string()));
        assert_eq!(config.codex_acp_binary, PathBuf::from("toml-codex-acp"));
        assert!(config.acp_args.is_empty());

        let config = direct_rubric_config(None, None);
        assert_eq!(config.codex_acp_binary, PathBuf::from("codex-acp"));
        assert!(config.acp_args.is_empty());
    }

    #[test]
    fn parses_full_configured_toml_schema() {
        let config: TomlConfig = toml::from_str(
            r#"
mode = "pipeline"

[vision]
url = "http://localhost:8013"
model = "qwen3-vl-8b"
api_key = "secret"
prompt = "Describe this UI."

[rubric]
backend = "opencode"
args = ["acp", "--debug"]
model = "deepseek-v4"
effort = "high"
system_prompt = "Return strict rubric JSON."
"#,
        )
        .unwrap();

        assert_eq!(config.mode, Some(ConfiguredMode::Pipeline));
        assert_eq!(config.vision.url.as_deref(), Some("http://localhost:8013"));
        assert_eq!(config.vision.model.as_deref(), Some("qwen3-vl-8b"));
        assert_eq!(config.vision.api_key.as_deref(), Some("secret"));
        assert_eq!(config.vision.prompt.as_deref(), Some("Describe this UI."));
        assert_eq!(config.rubric.backend.as_deref(), Some("opencode"));
        assert_eq!(
            config.rubric.args.as_deref(),
            Some(["acp".to_string(), "--debug".to_string()].as_slice())
        );
        assert_eq!(config.rubric.model.as_deref(), Some("deepseek-v4"));
        assert_eq!(config.rubric.effort.as_deref(), Some("high"));
        assert_eq!(
            config.rubric.system_prompt.as_deref(),
            Some("Return strict rubric JSON.")
        );
    }

    #[test]
    fn pipeline_mode_requires_vision_url() {
        let temp = tempfile::TempDir::new().unwrap();
        let config_path = temp.path().join("config.toml");
        std::fs::write(&config_path, "mode = \"pipeline\"\n").unwrap();

        let err = run_configured(ConfiguredArgs {
            image: temp.path().join("missing.png"),
            questions: QuestionSource::from_question("Does it render?".to_string()),
            name: "screenshot".to_string(),
            json: false,
            config: Some(config_path),
            mode: None,
            vision_url: None,
            vision_model: None,
            vision_api_key: None,
            vision_prompt: None,
            acp_binary: None,
            acp_args: Vec::new(),
            model: None,
            effort: None,
            system_prompt: None,
        })
        .unwrap_err();

        assert!(err.to_string().contains("vision URL is not set"));
    }

    #[test]
    fn invalid_mode_is_rejected_by_toml_parser() {
        let err = toml::from_str::<TomlConfig>("mode = \"gpt55\"").unwrap_err();

        assert!(err.to_string().contains("mode"));
    }
}