magi/config.rs
1//! Run configuration: the agent roster, the shape of the graph, and the
2//! blindness / verification policy.
3//!
4//! Discovery order (first hit wins):
5//!
6//! 1. `--config <path>`
7//! 2. `<repo>/magi.toml`
8//! 3. `<repo>/.magi/config.toml`
9//! 4. `<config_dir>/magi/config.toml`
10//! 5. built-in defaults, with the agent roster derived from the agent CLIs
11//! actually installed on this machine
12use std::collections::BTreeMap;
13use std::path::{Path, PathBuf};
14
15use anyhow::{Context as _, Result, bail};
16use serde::{Deserialize, Serialize};
17
18/// Which CLI drives an agent.
19#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
20#[serde(rename_all = "lowercase")]
21pub enum AgentKind {
22 /// Anthropic Claude Code (`claude -p`).
23 Claude,
24 /// opencode (`opencode run`).
25 Opencode,
26 /// Antigravity CLI (`agy -p`). Gemini CLI is deliberately absent: Google
27 /// retired the standalone client for individual accounts in favour of this
28 /// one, so an adapter for it would be dead code on a live machine.
29 Antigravity,
30 /// OpenAI Codex CLI (`codex exec`). The one roster member with a real
31 /// read-only mode: `--sandbox read-only` is enforced by the CLI, not by
32 /// the prompt.
33 Codex,
34 /// oh-my-pi (`omp -p --mode=json`). Another CLI with no read-only mode of
35 /// its own - `--auto-approve` gates reads and writes together - so a
36 /// read-only seat rests on the prompt and on the worktree discipline the
37 /// other non-codex seats already rely on. It is also the roster member that
38 /// reaches DeepSeek, whose models ship in `omp`'s own catalog.
39 Omp,
40 /// Arbitrary command. The escape hatch, and what the test suite drives.
41 Command,
42}
43
44impl AgentKind {
45 /// Executable that must be on `PATH` for this kind, if any.
46 pub fn program(self) -> Option<&'static str> {
47 match self {
48 Self::Claude => Some("claude"),
49 Self::Opencode => Some("opencode"),
50 Self::Antigravity => Some("agy"),
51 Self::Codex => Some("codex"),
52 Self::Omp => Some("omp"),
53 Self::Command => None,
54 }
55 }
56
57 /// Lowercase name as written in the config file.
58 pub fn as_str(self) -> &'static str {
59 match self {
60 Self::Claude => "claude",
61 Self::Opencode => "opencode",
62 Self::Antigravity => "antigravity",
63 Self::Codex => "codex",
64 Self::Omp => "omp",
65 Self::Command => "command",
66 }
67 }
68
69 /// Every kind the roster can name, in display order.
70 ///
71 /// This is what `magi doctor` lists, and it has to be one list rather than
72 /// the same set typed out again wherever a kind is enumerated. The last
73 /// time it was typed out twice, `omp` was added as a roster member and the
74 /// doctor output went on saying the machine had four CLIs - which reads as
75 /// "that agent is not installed" to the person the command exists for.
76 pub const ALL: [Self; 6] = [
77 Self::Claude,
78 Self::Opencode,
79 Self::Antigravity,
80 Self::Codex,
81 Self::Omp,
82 Self::Command,
83 ];
84}
85
86/// How the prompt reaches the agent process.
87#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
88#[serde(rename_all = "lowercase")]
89pub enum Delivery {
90 /// Piped on stdin.
91 Stdin,
92 /// Passed as a positional argument. Beware OS command-line limits.
93 Argv,
94 /// Written to a file; the agent is told to read it. No length limit.
95 File,
96}
97
98/// One addressable agent in the roster.
99#[derive(Debug, Clone, Deserialize, Serialize)]
100#[serde(deny_unknown_fields)]
101pub struct AgentSpec {
102 /// Stable identifier used by `[roles]` and by the stats tables.
103 pub id: String,
104 /// Which CLI to drive.
105 pub kind: AgentKind,
106 /// Model passed through to the CLI (`--model` / `-m`). CLI default if unset.
107 #[serde(default)]
108 pub model: Option<String>,
109 /// `kind = "command"` only: argv. Supports `{prompt_file}`, `{cwd}`,
110 /// `{label}`, `{session}` placeholders.
111 #[serde(default)]
112 pub command: Vec<String>,
113 /// Extra arguments appended to the built command line.
114 #[serde(default)]
115 pub extra_args: Vec<String>,
116 /// Extra environment variables for the child process.
117 #[serde(default)]
118 pub env: BTreeMap<String, String>,
119 /// Override the per-kind prompt delivery default.
120 #[serde(default)]
121 pub prompt_delivery: Option<Delivery>,
122}
123
124impl AgentSpec {
125 /// Default prompt delivery for this agent.
126 ///
127 /// `opencode` and `agy` take the prompt as an argument, which on Windows
128 /// caps out around 32 KiB — well under a judging prompt carrying three
129 /// patches — so both get a file instead.
130 pub fn delivery(&self) -> Delivery {
131 self.prompt_delivery.unwrap_or(match self.kind {
132 AgentKind::Claude | AgentKind::Command => Delivery::Stdin,
133 // `codex exec -` reads the prompt from stdin, so the whole
134 // instruction arrives without an argv length limit and without a
135 // tool round-trip to open a file.
136 AgentKind::Codex => Delivery::Stdin,
137 // `omp -p` reads the prompt from stdin too, and a judging prompt
138 // carrying three patches is well past the Windows argv cap, so this
139 // is the only delivery that works for every node.
140 AgentKind::Omp => Delivery::Stdin,
141 AgentKind::Opencode | AgentKind::Antigravity => Delivery::File,
142 })
143 }
144
145 /// Human-facing label, e.g. `opus (claude:opus)`.
146 pub fn display(&self) -> String {
147 match &self.model {
148 Some(m) => format!("{} ({}:{m})", self.id, self.kind.as_str()),
149 None => format!("{} ({})", self.id, self.kind.as_str()),
150 }
151 }
152}
153
154/// A standalone seat's agent: one roster id, or an ordered fallback chain.
155///
156/// The string form is what every existing config uses and serializes back as
157/// a string; the array form tries each id at most once, in order, moving on
158/// when a call ends in quota or fails (see [`crate::agent::pick_chain`]).
159/// An empty string or array is the same as unset.
160#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize)]
161#[serde(untagged)]
162pub enum AgentChoice {
163 /// One agent id.
164 One(String),
165 /// Ordered fallback chain of agent ids.
166 Chain(Vec<String>),
167}
168
169impl AgentChoice {
170 /// The ids named, in order, with blanks dropped. Empty means unset.
171 pub fn ids(&self) -> Vec<&str> {
172 let all: Vec<&str> = match self {
173 Self::One(id) => vec![id.as_str()],
174 Self::Chain(ids) => ids.iter().map(String::as_str).collect(),
175 };
176 all.into_iter()
177 .map(str::trim)
178 .filter(|id| !id.is_empty())
179 .collect()
180 }
181
182 /// The first id named, if any.
183 pub fn primary(&self) -> Option<&str> {
184 self.ids().into_iter().next()
185 }
186}
187
188impl From<&str> for AgentChoice {
189 fn from(id: &str) -> Self {
190 Self::One(id.to_owned())
191 }
192}
193
194/// The first id of an optional choice: what a single-seat caller resolves.
195pub fn primary(choice: Option<&AgentChoice>) -> Option<&str> {
196 choice.and_then(AgentChoice::primary)
197}
198
199/// Explicit role assignment. Empty lists are filled in by
200/// [`Config::resolve_roles`] by rotating the roster.
201#[derive(Debug, Clone, Default, Deserialize, Serialize)]
202#[serde(deny_unknown_fields, default)]
203pub struct Roles {
204 /// Agents that implement the task, one worktree each.
205 pub implementers: Vec<String>,
206 /// Agents that rank the candidates blind.
207 pub judges: Vec<String>,
208 /// Agents that review the winning patch.
209 pub reviewers: Vec<String>,
210 /// Agent that applies review findings. Defaults to the winner's author.
211 pub fixer: Option<String>,
212 /// Agent that answers the standing chat's turns (`src/talk.rs`).
213 ///
214 /// Unset picks a `claude` seat, else the first runnable agent in roster
215 /// order (see [`crate::agent::pick`]) - which is roster *order*, not a
216 /// judgement about who converses well. Naming one here matters once an
217 /// agent is also sitting as a judge: the chat is opened far more often
218 /// than any single competition, and every open competes with that judge
219 /// seat for the same account's concurrency. A timeout on an ordinary chat
220 /// turn traced to exactly this - `opus` triple-booked as chatter and judge
221 /// - is what this field exists to let an operator break apart.
222 ///
223 /// Accepts one id or an ordered array of ids: a fallback chain, see
224 /// [`AgentChoice`].
225 pub chatter: Option<AgentChoice>,
226 /// Agent that arranges the queue between polls: `crate::conduct`'s single
227 /// seat, called once per cycle to decide a runnable task's `blocked_by`
228 /// and how a stalled or finished task recovers.
229 ///
230 /// The same precedent as [`Self::chatter`] for a seat that stands alone
231 /// rather than rotating through the roster - resolved through
232 /// [`crate::agent::pick`], so unset falls back to its own default order
233 /// (a claude seat, else the first runnable agent) rather than reusing a
234 /// judge or reviewer seat that the conductor's own poll-cycle cadence
235 /// would otherwise compete with for the same account's concurrency.
236 ///
237 /// Accepts a string or a fallback chain, like [`Self::chatter`].
238 pub conductor: Option<AgentChoice>,
239 /// Seats for the design-deliberation stage `graph::Runner::advise` runs
240 /// before `implement`: independent, read-only design proposals gathered
241 /// once a run has a settled task instruction and before any implementer
242 /// touches the repository.
243 ///
244 /// Empty falls back to `judges` rather than to the whole roster: a panel
245 /// trusted to rank patches independently is exactly the panel worth
246 /// asking to sketch a design independently, and an operator who has
247 /// already thought about judge diversity gets advisor diversity for free
248 /// instead of a fourth roster to maintain.
249 pub advisors: Vec<String>,
250 /// Agent that blends [`Self::advisors`]' proposals into the one design
251 /// brief `graph::Runner::synthesize_brief` carries into every
252 /// implementer's prompt.
253 ///
254 /// The same precedent as [`Self::chatter`] and [`Self::conductor`] for a
255 /// seat that stands alone rather than rotating through the roster -
256 /// resolved through [`crate::agent::pick`], so unset falls back to its
257 /// own default order (a claude seat, else the first runnable agent in
258 /// roster order) - exactly today's behavior, unchanged by leaving this
259 /// field out.
260 ///
261 /// Accepts a string or a fallback chain, like [`Self::chatter`].
262 pub synthesizer: Option<AgentChoice>,
263}
264
265/// Graph shape and limits.
266#[derive(Debug, Clone, Deserialize, Serialize)]
267#[serde(deny_unknown_fields, default)]
268pub struct Graph {
269 /// Parallel implementations of the same task. **One by default.**
270 ///
271 /// Competition is the thing magi is for, and it is still here - it is just
272 /// no longer what every task buys without being asked. Three days and 13
273 /// runs on this repository, which is the workload these numbers are drawn
274 /// from:
275 ///
276 /// - **0 of 13** competed runs reached a merge. Everything that landed in
277 /// that window went through `magi review` - the cheap half, no
278 /// competition - and passed on the first try.
279 /// - The judges' first choices **split 73% of the time** (8 of 11
280 /// tallies). Candidates that close together make the ranking a weak
281 /// signal for what it costs to produce.
282 /// - One run's own breakdown: implement 60min, judge 40min, fix 40min,
283 /// review 28min, **verify 5min** - and verify is the node that caught a
284 /// defect every reviewer had passed as clean. The cheapest step is the
285 /// one that earns its place every time.
286 ///
287 /// It is not worthless: `oc` won 3 of those tallies against `sonnet`, so a
288 /// single-seat default would have shipped the worse implementation in
289 /// roughly a quarter of them. That is exactly why this is a *default* and
290 /// not a removal - `magi run --candidates N` and a per-task seat count are
291 /// how a task that deserves a competition gets one.
292 ///
293 /// A single-candidate run needs no special case: `Runner::review`'s doc
294 /// records that `execute` already degrades to implement -> review -> gate
295 /// -> merge, because `judge` skips a one-candidate field, `deliberate` has
296 /// no two first choices to reconcile and `vote` returns early.
297 pub candidates: usize,
298 /// Independent judges.
299 pub judges: usize,
300 /// Deliberation rounds when the judges' first choices disagree.
301 pub deliberate_rounds: usize,
302 /// Reviewers per review round. **Three by default** - the smallest panel
303 /// a lens cycle (see [`crate::prompt::Lens`]) covers exactly once, so the
304 /// default panel reads the patch for spec compliance, regressions, and
305 /// simplicity without repeating an angle. Review is also the one stage
306 /// [`Self::candidates`]'s doc describes as running on every task
307 /// regardless of competition, which is what makes a panel worth its cost
308 /// here even though `candidates` itself defaults to one.
309 pub reviewers: usize,
310 /// Maximum review+fix rounds before the run is declared blocked.
311 pub review_rounds: usize,
312 /// Fix rounds a failing `verify.gate` gets before the run is blocked. The
313 /// fixer is handed the gate's own output; `0` keeps the old behaviour of
314 /// blocking on the first red gate. Independent of [`Self::review_rounds`]
315 /// so a run that spent its review budget can still repair a one-line gate
316 /// failure.
317 pub gate_fix_rounds: usize,
318 /// Maximum agent processes running at once.
319 pub max_parallel: usize,
320 /// Language for the prose the agents write (`en` / `ja` / any language name).
321 pub language: String,
322 /// Keep one CLI conversation per seat, so a judge remembers its own
323 /// argument across deliberation rounds and the fixer remembers its own
324 /// implementation across review rounds.
325 ///
326 /// Sessions are scoped to a *seat*, never to an agent id: the same model
327 /// sitting as implementer and as judge gets two unrelated conversations,
328 /// which is what keeps blind judging blind.
329 pub sessions: bool,
330 /// Per-node timeouts, seconds.
331 pub timeout_implement: u64,
332 /// Per-node timeouts, seconds.
333 pub timeout_judge: u64,
334 /// Per-node timeouts, seconds.
335 pub timeout_review: u64,
336 /// Timeout for `verify.e2e` and `verify.gate`, seconds. Separate from
337 /// [`Self::timeout_review`] so shrinking a reviewer's budget cannot
338 /// silently shrink a real-machine command's budget too — the two used to
339 /// share `timeout_review`, and turning a slow reviewer down cut the
340 /// timeout `cargo test --all-targets` runs under along with it. When
341 /// omitted, preserves legacy configurations by using
342 /// [`Self::timeout_review`]. Set an explicit value to make verification
343 /// independent of later review-seat budget changes.
344 pub timeout_verify: Option<u64>,
345 /// Per-node timeouts, seconds.
346 pub timeout_fix: u64,
347 /// Wall-clock limit for one turn of [`crate::talk`]'s standing
348 /// conversation, seconds.
349 ///
350 /// An hour: the operator is not watching this turn resolve in real time,
351 /// so the budget can match what the work - reading files, running
352 /// commands, checking their output - actually needs rather than what a
353 /// person waiting on a phone can tolerate.
354 pub timeout_talk: u64,
355 /// Retries for an agent invocation that fails or returns nothing usable.
356 pub retries: usize,
357 /// Root for candidate / judge worktrees. Defaults to `~/wt/magi`.
358 pub worktree_root: Option<PathBuf>,
359 /// After the pull request is open, keep going: watch its checks and
360 /// reviews, run a fix round when they are unhappy, and ask to merge.
361 ///
362 /// On, because stopping at an open pull request left the operator doing
363 /// the watching by hand - six times in the session this was built in - and
364 /// that is the work the loop exists to take. It only engages for
365 /// `merge = "pr"`; every other merge mode ends the run as before.
366 ///
367 /// Turning this on does **not** hand magi the merge button:
368 /// [`Graph::land_approval`] is on too, and nothing merges without an
369 /// explicit answer. Setting both to their non-defaults is the only way to
370 /// get an unattended merge, and it has to be chosen twice.
371 pub land: bool,
372 /// Land rounds - watch, fix, push - before the run is left for a human.
373 pub land_rounds: usize,
374 /// Ask the owner before merging, showing what is about to land.
375 ///
376 /// On, and it is what makes `land` safe to have on: the question carries a
377 /// rendered panel - the diffstat, the patch, the checks, the review
378 /// comments that were addressed, and the subject the squash will use - so
379 /// the decision is made on evidence rather than on trust, from wherever
380 /// the operator happens to be.
381 ///
382 /// Silence is a hold. An unanswered approval never merges, and neither
383 /// does any answer other than the word `merge`.
384 pub land_approval: bool,
385 /// Ask the owner before merging a run whose review loop handed off over a
386 /// contested finding: the last round ended with a Major-or-above finding
387 /// still open *and* at least one reviewer's final vote (after
388 /// reconsideration) was reject. Findings raised in the last round are
389 /// never fixed or re-reviewed, so this is the one case an unattended
390 /// merge would land over a reviewer's explicit objection.
391 ///
392 /// On. Interaction with [`Self::land_approval`]: when that is on, every
393 /// merge is asked about and this key changes nothing. When it is off,
394 /// this key alone decides whether a contested hand-off is asked about
395 /// (the question says why); every other run still merges unattended.
396 /// Read at land time, so turning it off restores the unattended merge at
397 /// once. The pull request is opened either way; only the merge waits.
398 pub hold_contested_merge: bool,
399 /// After a run's pull request merges, file the findings its last review
400 /// round left open as follow-up tasks (`crate::followup`) instead of
401 /// letting them vanish with the merge: every Major-or-above finding, and
402 /// every finding of a seat whose final vote was reject. Other Minor/Nit
403 /// findings are only listed in the pull-request comment. Does not affect
404 /// whether the merge happens. On; best-effort, a failure is a run event.
405 pub file_followups: bool,
406 /// How long to wait for an owner to answer a question before the run is
407 /// abandoned, seconds. A parked run costs nothing, so this is generous;
408 /// it exists so a forgotten question cannot pin a worktree forever.
409 pub answer_timeout: u64,
410 /// What a round does when one or more reviewer seats never answered
411 /// (timeout, crash, unparsable output).
412 pub incomplete_review: IncompleteReviewPolicy,
413 /// Run `verify.e2e` on every round, even one that already has blocking
414 /// findings and another round left to try.
415 ///
416 /// Off by default: a round with a blocking finding and rounds still left
417 /// is going back to the fixer regardless of what `verify.e2e` says, so
418 /// running it first only spends the round's slowest step (minutes, on a
419 /// Rust repo's `cargo test --all-targets`) on a head about to be
420 /// rewritten anyway. `verify.e2e` still runs once a round has no
421 /// blocking findings left (a round cannot go `clean` without it) and the
422 /// final `verify.gate` always runs on the actual tree that would land —
423 /// deferring is about *when* e2e runs mid-loop, never about skipping it.
424 ///
425 /// Set this to restore the old every-round diagnostic behaviour: e2e
426 /// output from a round that still has blocking findings is occasionally
427 /// useful on its own (a runtime failure a reviewer's panel would not
428 /// have caught by reading), and this is the way back to seeing it every
429 /// round instead of only once the panel has nothing left to flag.
430 pub e2e_every_round: bool,
431 /// Run the design-deliberation stage before `implement`: independent
432 /// advisor seats each sketch a design, and (when at least one produced a
433 /// usable proposal) a synthesis blends them into a brief carried in the
434 /// implementer's prompt. See `graph::Runner::advise`.
435 ///
436 /// On by default. A design sketch is a few paragraphs an agent can write
437 /// without touching the repository, where a full implementation is a
438 /// tool loop that re-reads the codebase on every turn - so three
439 /// sketches, gathered once before `implement` starts, cost a fraction of
440 /// a fourth candidate and buy back a form of the same disagreement
441 /// [`Self::candidates`]'s doc describes moving away from being the
442 /// default, on every run rather than only the ones an operator remembers
443 /// to ask for with `--candidates`.
444 pub advise: bool,
445 /// How many independent design proposals the deliberation stage gathers.
446 /// **Three by default** - the same number [`Self::candidates`]'s doc
447 /// names as the point where a fourth judge's first choice stopped
448 /// changing the tally.
449 pub advisors: usize,
450}
451
452impl Default for Graph {
453 fn default() -> Self {
454 Self {
455 candidates: 1,
456 judges: 3,
457 deliberate_rounds: 1,
458 reviewers: 3,
459 review_rounds: 6,
460 gate_fix_rounds: 1,
461 max_parallel: 4,
462 language: "en".to_owned(),
463 sessions: true,
464 timeout_implement: 3600,
465 timeout_judge: 1200,
466 timeout_review: 1200,
467 timeout_verify: None,
468 timeout_fix: 1800,
469 timeout_talk: 3600,
470 retries: 1,
471 worktree_root: None,
472 land: true,
473 land_rounds: 4,
474 land_approval: true,
475 hold_contested_merge: true,
476 file_followups: true,
477 answer_timeout: 86_400,
478 incomplete_review: IncompleteReviewPolicy::Block,
479 e2e_every_round: false,
480 advise: true,
481 advisors: 3,
482 }
483 }
484}
485
486impl Graph {
487 /// Effective machine-command budget. Older configuration files had only
488 /// `timeout_review`, which also governed verification, so absence is a
489 /// compatibility fallback rather than a new 1200-second default.
490 pub fn verify_timeout(&self) -> u64 {
491 self.timeout_verify.unwrap_or(self.timeout_review)
492 }
493}
494
495/// What a review round does when a reviewer seat never answered.
496///
497/// A round where half the panel timed out is not evidence of a clean patch —
498/// it is evidence of nothing. The default refuses to call that clean; `warn`
499/// exists for an operator who would rather keep a flaky seat from stalling
500/// every run, and accepts that the gap is on them to read in the report.
501#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
502#[serde(rename_all = "lowercase")]
503pub enum IncompleteReviewPolicy {
504 /// A round with a missing seat is never `clean`: with nothing raised to
505 /// fix, the round is re-reviewed instead of gating; with the max rounds
506 /// exhausted, the run is left `Blocked` rather than declared ready.
507 Block,
508 /// A round with a missing seat can still gate as clean, once every seat
509 /// that *did* answer raised nothing blocking and verification is green.
510 /// The record keeps the gap visible (`magi show`, `magi stats`) even
511 /// though the run does not wait on it.
512 Warn,
513}
514
515/// What to do when vendor-identifying text is found in material shown to judges.
516#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
517#[serde(rename_all = "lowercase")]
518pub enum LeakPolicy {
519 /// Record the leak, show the patch unmodified.
520 Warn,
521 /// Replace the token with `[REDACTED]` in the presented patch.
522 Redact,
523 /// Abort the run.
524 Fail,
525}
526
527/// Blindness policy.
528///
529/// Commit messages and candidate summaries are *always* stripped of
530/// attribution trailers and redacted — that is where signatures actually
531/// appear. [`Blind::on_leak`] governs the patch body only, where blanket
532/// redaction would corrupt the artifact under judgement.
533#[derive(Debug, Clone, Deserialize, Serialize)]
534#[serde(deny_unknown_fields, default)]
535pub struct Blind {
536 /// Install a per-worktree `commit-msg` hook that deletes attribution
537 /// trailers before they can land in a candidate's history.
538 pub commit_msg_hook: bool,
539 /// Literal, case-insensitive substrings. A line containing any of them is
540 /// dropped from commit messages and summaries; the `commit-msg` hook is
541 /// generated from the same list.
542 pub strip_lines: Vec<String>,
543 /// Case-insensitive substrings that identify a vendor or model.
544 pub vendor_tokens: Vec<String>,
545 /// Policy for vendor tokens found in the patch body.
546 pub on_leak: LeakPolicy,
547 /// Seed for label assignment and per-judge presentation order. Derived from
548 /// the run id when unset; set it to make a run reproducible.
549 pub seed: Option<u64>,
550}
551
552impl Default for Blind {
553 fn default() -> Self {
554 Self {
555 commit_msg_hook: true,
556 strip_lines: [
557 "Co-Authored-By:",
558 "Signed-off-by:",
559 "Assisted-by:",
560 "Generated-by:",
561 "Generated with",
562 "\u{1f916}",
563 ]
564 .iter()
565 .map(|s| (*s).to_owned())
566 .collect(),
567 vendor_tokens: [
568 "claude",
569 "anthropic",
570 "codex",
571 "openai",
572 "chatgpt",
573 "gemini",
574 "grok",
575 "xai",
576 "copilot",
577 "opencode",
578 "qoder",
579 "cursor",
580 "\u{1f916}",
581 ]
582 .iter()
583 .map(|s| (*s).to_owned())
584 .collect(),
585 on_leak: LeakPolicy::Warn,
586 seed: None,
587 }
588 }
589}
590
591/// Shell commands that gate the winner.
592#[derive(Debug, Clone, Default, Deserialize, Serialize)]
593#[serde(deny_unknown_fields, default)]
594pub struct Verify {
595 /// Run in the winner's worktree once per review round. Its output is fed
596 /// back to the fixer. This is the "real machine" leg of the review.
597 pub e2e: Vec<String>,
598 /// Final gate. Must all exit 0 before a merge is attempted.
599 pub gate: Vec<String>,
600 /// Mechanical fixers (formatters) run in the winner's worktree just before
601 /// `gate`, after review is clean. Anything they change is committed as one
602 /// neutral-identity commit so the gate and the PR see it. A command that
603 /// fails or times out is a warning, never a failed run: the gate stays the
604 /// single arbiter. Empty (the default) turns the feature off. Runs under
605 /// `graph.verify_timeout()` per command, like the gate. Meant for light
606 /// tools: it is not scanned for `CARGO_TARGET_DIR`, and it should be
607 /// idempotent since a resumed run may repeat it.
608 #[serde(default)]
609 pub pre_gate: Vec<String>,
610 /// Shell used to run the commands above. Defaults to `sh -c`, or
611 /// `cmd /C` when `sh` is not on `PATH`.
612 pub shell: Option<Vec<String>>,
613}
614
615impl Verify {
616 /// The `CARGO_TARGET_DIR=` value of the first rendered command that sets
617 /// one, if any. See [`crate::disk::extract_cargo_target_dir`] for the shape
618 /// this reads back. One rendering is enough - they all set the same
619 /// rendered `{{ vars.cache }}` path via the same shell - and the first e2e
620 /// command is checked before the gate because the e2e rebuilds the crate.
621 pub fn cache_dir(&self) -> Option<PathBuf> {
622 self.e2e
623 .iter()
624 .chain(self.gate.iter())
625 .find_map(|cmd| crate::disk::extract_cargo_target_dir(cmd))
626 }
627}
628
629/// Disk hygiene: how hard magi is allowed to press on the machine's free space.
630///
631/// The numbers below come from one incident, not from theory: a machine with
632/// 951.8 GB free ran a few competitions and plans and best read 6.7 GB free.
633/// Three multi-gigabyte classes of junk accumulated side by side - per-run
634/// worktrees that end as `Merged`/`Ready`/`Failed`, a shared build cache whose
635/// each verify round and each implementation wave recompiles the derived
636/// section of the project into, and the outputs of runs that were removed but
637/// whose folders nobody deleted.
638#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
639#[serde(deny_unknown_fields, default)]
640pub struct Disk {
641 /// Free space, in bytes, below which no new run may start: the daemon and
642 /// the `magi run` gate answer with "the disk is full" instead of letting
643 /// the graph fill it the rest of the way. `0` turns the gate off.
644 ///
645 /// Default 8 GiB. The incident ran down to 6.7 GB free of 951.8 GB total
646 /// before anybody noticed; 8 GiB is enough headroom for the compile a fresh
647 /// competition triggers and small enough that a 1 TB disk with 100 GB free
648 /// is nowhere near the threshold.
649 pub min_free_bytes: u64,
650 /// Fold finished runs without being asked. `Merged`, `Ready` and `Failed`
651 /// runs older than [`fold_grace_secs`](Self::fold_grace_secs) have their
652 /// worktrees removed. `0` turns the janitor off.
653 ///
654 /// Default true.
655 pub auto_fold: bool,
656 /// How old a finished run must be before the janitor folds it, seconds.
657 ///
658 /// Default 6 hours. A run that `Ready` at 8am is the operator's answer; a
659 /// run that `Ready` a week ago is worktrees holding a compile each. Six
660 /// hours is long enough that nobody loses an answer in the gap between
661 /// reading the report and starting from it, and short enough that a backlog
662 /// cannot pile up across two nights.
663 pub fold_grace_secs: u64,
664 /// Ceiling for the shared build cache (`CARGO_TARGET_DIR` in the rendered
665 /// verify commands), in bytes. When the janitor runs and the cache is over
666 /// it, files are dropped oldest-first until it is not. `0` turns pruning
667 /// off - the cache then only ever grows, which is the operator's call.
668 ///
669 /// Default 10 GiB. This is what the incident measured: 30.61 GB sat in the
670 /// shared cache on top of ~16 GB in the primary target directory and 6.7-
671 /// 11.15 GB in each of four per-worktree targets. 10 GiB holds a healthy
672 /// stack of prebuilt dependencies (cargo's per-file fingerprinting means
673 /// pruning only costs the rebuild of the dropped files, not of the world)
674 /// without letting one addled cache swallow the machine.
675 pub cache_limit_bytes: u64,
676}
677
678impl Default for Disk {
679 fn default() -> Self {
680 Self {
681 min_free_bytes: 8 * 1024 * 1024 * 1024,
682 auto_fold: true,
683 fold_grace_secs: 6 * 60 * 60,
684 cache_limit_bytes: 10 * 1024 * 1024 * 1024,
685 }
686 }
687}
688
689/// What to do with the winning branch.
690#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
691#[serde(rename_all = "lowercase")]
692pub enum MergeMode {
693 /// Leave the branch alone and print the merge command matching
694 /// [`Merge::style`].
695 None,
696 /// Merge into the base branch in the primary worktree, using
697 /// [`Merge::style`].
698 Local,
699 /// Push the branch and open a PR with `gh pr create`. Landing this PR
700 /// (`[graph] land`) always squashes — see `land`'s module doc — so
701 /// [`Merge::style`] does not apply here.
702 Pr,
703}
704
705/// How the winning branch is attached to the base branch: what
706/// `mode = "local"` runs, and what `mode = "none"`'s printed guidance tells
707/// the operator to run by hand.
708///
709/// Read from configuration rather than asked of the repository at run time
710/// (e.g. `gh api repos/{owner}/{repo}/rulesets`) for two reasons: it keeps
711/// `mode = "none"`'s guidance a pure function of `RunState`, assertable in a
712/// unit test the same way `land::decide` is kept pure (see that module's
713/// doc), and it works for a base branch that is not hosted on GitHub, or not
714/// reachable at all, at the moment the report is rendered. An operator whose
715/// base branch enforces a ruleset already knows what it allows; declaring it
716/// once here is cheaper than magi re-discovering it, with a network call, on
717/// every render.
718#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Deserialize, Serialize)]
719#[serde(rename_all = "lowercase")]
720pub enum MergeStyle {
721 /// `git merge --no-ff`: every candidate commit lands, plus a merge
722 /// commit that records the merge as its own event in history. Rejected
723 /// by a base branch whose ruleset requires linear history or forbids
724 /// merge commits outright.
725 #[default]
726 Merge,
727 /// `git merge --squash` followed by a commit under an explicit message:
728 /// every candidate commit folds into one, and none of the candidate's
729 /// own placeholder subjects (`magi: candidate A (uncommitted work)`)
730 /// reach the base branch. No merge commit, so this satisfies a linear-
731 /// history ruleset.
732 Squash,
733 /// A fast-forward-only merge: every candidate commit lands verbatim, in
734 /// order, with no merge commit. Only succeeds because the winner was
735 /// already rebased onto the tracked base tip before this runs (see
736 /// `Runner::sync_to_base`) — equivalent to GitHub's "rebase and merge"
737 /// once that has happened.
738 Rebase,
739}
740
741/// Merge policy.
742#[derive(Debug, Clone, Deserialize, Serialize)]
743#[serde(deny_unknown_fields, default)]
744pub struct Merge {
745 /// Default is [`MergeMode::None`]: magi never touches your base branch
746 /// unless you ask it to.
747 pub mode: MergeMode,
748 /// Base branch. Defaults to the branch checked out when the run started.
749 pub base: Option<String>,
750 /// How the winner is attached to `base`; see [`MergeStyle`]. Ignored by
751 /// `mode = "pr"`.
752 pub style: MergeStyle,
753 /// Remote for `mode = "pr"`.
754 pub remote: String,
755 /// After a `mode = "pr"` run lands, open a `chore/release-vX.Y.Z` pull
756 /// request sized to the change by an agent's own judgement, so a version
757 /// bump does not depend on a human remembering to cut one.
758 ///
759 /// Only acts on Rust repositories (a `Cargo.toml` at the root of the base
760 /// branch); on any other repository it is a no-op that records one event.
761 ///
762 /// On by default. **Turning this off means a merge landed from the phone
763 /// never becomes a release**, so `POST /api/upgrade` keeps reporting
764 /// "already on the newest release" against a `main` that has moved past
765 /// it - the same gap this feature exists to close. Only for a repository
766 /// that wants to keep cutting releases by hand.
767 pub release_bump: bool,
768}
769
770impl Default for Merge {
771 fn default() -> Self {
772 Self {
773 mode: MergeMode::None,
774 base: None,
775 style: MergeStyle::default(),
776 remote: "origin".to_owned(),
777 release_bump: true,
778 }
779 }
780}
781
782/// How magi keeps itself current.
783#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
784#[serde(rename_all = "lowercase")]
785pub enum UpdateMode {
786 /// Never check.
787 Off,
788 /// Check in the background and print a one-line banner when a newer
789 /// release exists.
790 Notify,
791 /// Check and install silently.
792 Install,
793}
794
795/// Self-update policy.
796#[derive(Debug, Clone, Deserialize, Serialize)]
797#[serde(deny_unknown_fields, default)]
798pub struct Update {
799 /// Default is [`UpdateMode::Notify`]: magi tells you, and lets you decide.
800 pub mode: UpdateMode,
801 /// Minimum time between checks, e.g. `24h`. kaishin's default when unset.
802 pub interval: Option<String>,
803}
804
805impl Default for Update {
806 fn default() -> Self {
807 Self {
808 mode: UpdateMode::Notify,
809 interval: None,
810 }
811 }
812}
813
814/// Top-level configuration.
815#[derive(Debug, Clone, Default, Deserialize, Serialize)]
816#[serde(deny_unknown_fields, default)]
817pub struct Config {
818 /// Agent roster.
819 pub agents: Vec<AgentSpec>,
820 /// Role assignment.
821 pub roles: Roles,
822 /// Graph shape.
823 pub graph: Graph,
824 /// Blindness policy.
825 pub blind: Blind,
826 /// Verification commands.
827 pub verify: Verify,
828 /// Disk hygiene.
829 pub disk: Disk,
830 /// Merge policy.
831 pub merge: Merge,
832 /// Self-update policy.
833 pub update: Update,
834 /// Project-specific text appended to the node prompts.
835 pub prompts: Prompts,
836 /// How the operator is told a run is waiting on them.
837 pub notify: Notify,
838 /// Local repositories the plan surface can start or derive a conversation
839 /// against.
840 pub repos: Repos,
841 /// Policy for the standing conversation ([`crate::talk`]).
842 pub talk: Talk,
843 /// How many runs `magi serve`'s own loop drives at once.
844 pub daemon: Daemon,
845 /// Context-window sizes in tokens, keyed by model name, merged over
846 /// [`BUILTIN_CONTEXT_WINDOWS`]. See [`Config::context_window`].
847 pub context_windows: BTreeMap<String, u64>,
848}
849
850/// Context windows of models magi commonly drives, in tokens.
851///
852/// A convenience, not a source of truth: vendors resize windows and ship new
853/// models faster than this table is edited, so an entry that is stale or
854/// missing is fixed by `[context_windows]` in `magi.toml`, which wins. Matched
855/// by [`Config::context_window`]: exact name first, then the longest key that
856/// prefixes the model name (so a dated or suffixed id such as
857/// `claude-sonnet-4-5-20250929` finds `claude-sonnet-4-5`). A model matching
858/// nothing has no percentage - the UI shows the raw count.
859const BUILTIN_CONTEXT_WINDOWS: &[(&str, u64)] = &[
860 ("claude-opus-4", 200_000),
861 ("claude-sonnet-4", 200_000),
862 ("claude-haiku-4", 200_000),
863 ("claude-3", 200_000),
864 ("opus", 200_000),
865 ("sonnet", 200_000),
866 ("haiku", 200_000),
867 ("gpt-5", 400_000),
868 ("gpt-4.1", 1_000_000),
869 ("gpt-4o", 128_000),
870 ("o3", 200_000),
871 ("o4-mini", 200_000),
872 ("gemini-2.5", 1_000_000),
873 ("deepseek", 128_000),
874];
875
876impl Config {
877 /// Context window in tokens for `model`: `[context_windows]` first, then
878 /// the built-in table; within each, an exact name beats the longest
879 /// prefix. `None` for an unknown model, which is a deliberate answer -
880 /// guessing a denominator would print a confident wrong percentage.
881 pub fn context_window(&self, model: &str) -> Option<u64> {
882 fn lookup<'a>(model: &str, entries: impl Iterator<Item = (&'a str, u64)>) -> Option<u64> {
883 let mut best: Option<(usize, u64)> = None;
884 for (key, window) in entries {
885 if key == model {
886 return Some(window);
887 }
888 if model.starts_with(key) && best.is_none_or(|(len, _)| key.len() > len) {
889 best = Some((key.len(), window));
890 }
891 }
892 best.map(|(_, w)| w)
893 }
894 lookup(
895 model,
896 self.context_windows.iter().map(|(k, w)| (k.as_str(), *w)),
897 )
898 .or_else(|| lookup(model, BUILTIN_CONTEXT_WINDOWS.iter().copied()))
899 }
900}
901
902/// How the daemon loop itself behaves, as opposed to what one run does.
903///
904/// Machine-layer material in the same sense [`Repos::roots`] is: how many
905/// competitions this machine's own loop is willing to babysit at once is a
906/// fact about the machine running `magi serve`, not about any one
907/// repository's task, so it belongs in `<config_dir>/magi/config.toml`
908/// rather than a repository's own `magi.toml` - though, like `Repos::roots`,
909/// nothing stops a repository from setting it too, since a scalar field
910/// takes whichever layer has the highest precedence.
911#[derive(Debug, Clone, Deserialize, Serialize)]
912#[serde(deny_unknown_fields, default)]
913pub struct Daemon {
914 /// How many runs `magi serve` may have actively in flight at once.
915 /// **One by default** - today's behaviour, one run at a time.
916 ///
917 /// This is a different knob from [`Graph::max_parallel`], and the two
918 /// must not be confused: `max_parallel` bounds how many agent *processes*
919 /// one run starts inside itself (implementers, judges, reviewers -
920 /// candidates competing on a single task); this field bounds how many
921 /// *runs* - whole competitions, each with its own `max_parallel` budget -
922 /// the loop drives side by side, possibly across different tasks and
923 /// different repositories. Raising `max_parallel` buys a bigger panel for
924 /// one task; raising this buys more tasks worked at once. A config file
925 /// that meant one and wrote the other would either starve a competition
926 /// of judges or leave the rest of the backlog waiting for no reason.
927 ///
928 /// A run parked waiting on the operator's land-merge approval - see
929 /// [`crate::land`] - does not hold one of these slots while it waits: the
930 /// whole point of parking there is to let the loop spend the slot on
931 /// something runnable instead of sitting on a decision only a human can
932 /// make. So even at the default of `1`, an approval that comes back does
933 /// not queue behind whatever else the loop happens to be running.
934 pub max_concurrent_runs: usize,
935 /// Let a task marked [`crate::queue::Task::interrupt`] (`magi task
936 /// interrupt`) cut ahead of whatever `magi serve` already has in flight,
937 /// instead of waiting for it to finish.
938 ///
939 /// **Off by default.** When enabled, a run that is in flight and is not
940 /// itself the interrupt candidate may be paused at its next safe node
941 /// boundary - see [`crate::graph::Runner::park_here`] - so the marked
942 /// task can run alone; the paused run resumes automatically, through the
943 /// same path any other parked run does, the moment the interrupting
944 /// task's own run reaches a terminal status. This is opt-in because it
945 /// bends the loop's own "one run at a time" principle (see this repository's
946 /// `magi serve` help) for a specific, explicit operator request, and a
947 /// repository that never files an interrupt task pays nothing for having
948 /// it on - but an operator who does not want any run of theirs preempted,
949 /// ever, should leave this `false`.
950 pub pause_for_interrupts: bool,
951 /// How many deputies `magi serve` runs at once. A deputy is the short-lived
952 /// seat that waits on one open conductor question (see [`crate::deputy`]);
953 /// each is a live agent conversation, so this is bounded - **two by
954 /// default**, because the agent CLIs' quota is the scarce resource. A
955 /// question over the limit keeps its place and starts when a deputy
956 /// finishes; `0` runs none.
957 pub max_deputies: usize,
958 /// Minutes a release-bump pull request may make no progress before
959 /// `magi serve` raises a notice and asks the owner (see
960 /// [`crate::release_watch`]). Progress is a change of head commit or of any
961 /// check's verdict. A required check that stays red after the one rerun the
962 /// watcher is allowed escalates at once, whatever this says. **Sixty by
963 /// default**; `0` turns the watcher off.
964 pub release_stall_minutes: u64,
965}
966
967impl Default for Daemon {
968 fn default() -> Self {
969 Self {
970 max_concurrent_runs: 1,
971 pause_for_interrupts: false,
972 max_deputies: 2,
973 release_stall_minutes: 60,
974 }
975 }
976}
977
978/// Where `magi repos` and `GET /api/repos` look for local checkouts.
979///
980/// `roots` is one of the array keys [`array_merge_policy`] marks as
981/// append-across-layers: which checkouts exist in general is a *machine*
982/// fact in the same way the agent roster is - a repository's own `magi.toml`
983/// cannot state where its siblings live before magi has resolved which
984/// repository to read that file from in the first place - but a repository
985/// that genuinely has an extra root worth scanning is not forced to choose
986/// between an error and losing the machine's roots outright. Both layers'
987/// roots are scanned; see [`Config::refuse_split_arrays`] for the keys that
988/// are still refused.
989#[derive(Debug, Clone, Deserialize, Serialize)]
990#[serde(deny_unknown_fields, default)]
991pub struct Repos {
992 /// Roots to scan for a ghq-layout checkout: `<root>/<host>/<owner>/<repo>`
993 /// with a `.git` directory. Empty by default - nothing is scanned unless
994 /// asked to be.
995 pub roots: Vec<PathBuf>,
996 /// How long a scan is trusted before the next request re-scans it,
997 /// seconds. `0` means never trust it: scan on every request. Defaults to
998 /// a day, the same order of magnitude as [`Graph::answer_timeout`] for
999 /// the same reason - a checkout does not usually appear or vanish inside
1000 /// a session, so there is little to gain from scanning more often than
1001 /// that, and an explicit refresh exists for the moment one does.
1002 pub scan_ttl: u64,
1003 /// How often `magi serve` runs `git fetch origin` in every checkout under
1004 /// `roots`, seconds, so `origin/main` stays fresh whatever state the
1005 /// working tree is in. Fetch only: no branch, HEAD or working tree is
1006 /// touched. `0` disables it.
1007 pub fetch_interval: u64,
1008}
1009
1010impl Default for Repos {
1011 fn default() -> Self {
1012 Self {
1013 roots: Vec::new(),
1014 scan_ttl: 86_400,
1015 fetch_interval: 600,
1016 }
1017 }
1018}
1019
1020/// Project-specific text appended to each node's prompt.
1021///
1022/// **Additive by construction.** These fields cannot replace magi's prompts,
1023/// only extend them, and that restriction is the whole design. The built-in
1024/// prompts carry the invariants the competition rests on: a judging prompt
1025/// names no authors, every structured answer must arrive as one fenced `json`
1026/// block, and a judge is told not to speculate about who wrote what. A config
1027/// that could overwrite them would let a typo silently un-blind the panel or
1028/// break the parser, and the symptom would be "the judges got worse" rather
1029/// than an error.
1030///
1031/// Repository-wide context belongs in `AGENTS.md`, which every agent already
1032/// reads from the checkout. Use these fields for the things a *magi node*
1033/// needs to know and a repository file cannot say - for instance that
1034/// reviewers here should ignore formatting because a hook owns it.
1035#[derive(Debug, Clone, Default, Deserialize, Serialize)]
1036#[serde(deny_unknown_fields, default)]
1037pub struct Prompts {
1038 /// Appended to every node's prompt.
1039 pub all: String,
1040 /// Appended for implementers.
1041 pub implement: String,
1042 /// Appended for judges, both ranking and voting.
1043 pub judge: String,
1044 /// Appended for reviewers.
1045 pub review: String,
1046 /// Appended for the fixer.
1047 pub fix: String,
1048}
1049
1050impl Prompts {
1051 /// The overlay for one node, or `None` when nothing is configured.
1052 ///
1053 /// `node` is the graph's own node name, so a new node gets no overlay
1054 /// rather than the wrong one.
1055 pub fn overlay(&self, node: &str) -> Option<String> {
1056 let specific = match node {
1057 "implement" => &self.implement,
1058 "judge" | "vote" | "deliberate" => &self.judge,
1059 "review" => &self.review,
1060 "fix" => &self.fix,
1061 _ => "",
1062 };
1063 let mut parts: Vec<&str> = Vec::new();
1064 for p in [self.all.trim(), specific.trim()] {
1065 if !p.is_empty() {
1066 parts.push(p);
1067 }
1068 }
1069 if parts.is_empty() {
1070 return None;
1071 }
1072 Some(parts.join("\n\n"))
1073 }
1074}
1075
1076/// How the operator is told that a run is waiting on them.
1077///
1078/// A command rather than a built-in integration: magi is one binary with no
1079/// network dependencies, and every operator's notification path is different -
1080/// ntfy, a Slack webhook, a Windows toast, an SSH to a machine that beeps.
1081/// Shelling out keeps all of them possible and none of them magi's problem.
1082#[derive(Debug, Clone, Default, Deserialize, Serialize)]
1083#[serde(deny_unknown_fields, default)]
1084pub struct Notify {
1085 /// Command and arguments. `{summary}`, `{run}` and `{url}` are replaced.
1086 /// Empty means no notification - the web UI is then the only surface.
1087 pub command: Vec<String>,
1088}
1089
1090/// Policy for [`crate::talk`], the standing conversation.
1091#[derive(Debug, Clone, Default, Deserialize, Serialize)]
1092#[serde(deny_unknown_fields, default)]
1093pub struct Talk {
1094 /// Let the conversation's agent edit files in the repository instead of
1095 /// filing a task for one. **Off by default** - see
1096 /// [`crate::talk`]'s module doc for why an edit made mid-conversation is
1097 /// an edit no run and no review can be attributed to, which is exactly
1098 /// the property a repository entered in a competition depends on. A
1099 /// repository that is never judged - dotfiles, a personal config
1100 /// checkout - has nothing to lose by turning this on in its own
1101 /// `magi.toml`, and a one-line fix stops costing a queued task to get.
1102 pub allow_write: bool,
1103}
1104
1105/// Roles resolved to concrete agent specs for one run.
1106#[derive(Debug, Clone)]
1107pub struct ResolvedRoles {
1108 /// One per candidate.
1109 pub implementers: Vec<AgentSpec>,
1110 /// One per judge.
1111 pub judges: Vec<AgentSpec>,
1112 /// One per reviewer slot.
1113 pub reviewers: Vec<AgentSpec>,
1114 /// Explicit fixer, if configured.
1115 pub fixer: Option<AgentSpec>,
1116 /// Queue conductor, explicitly selected or resolved by the standalone-seat fallback.
1117 pub conductor: AgentSpec,
1118 /// The full ordered implementer roster, in [`Roles::implementers`]'s own
1119 /// order — or `[[agents]]` in file order, when that list is empty. Unlike
1120 /// [`Self::implementers`], never truncated to `graph.candidates` and
1121 /// never `rotate`d/wrapped: a solo run (`candidates = 1`) resolves
1122 /// `implementers` down to a single slot, but `graph::Runner`'s per-seat
1123 /// quota fallback needs the *whole* list to walk forward through when
1124 /// that one slot's agent runs out of quota mid-run.
1125 pub implementer_roster: Vec<AgentSpec>,
1126 /// [`Self::implementer_roster`]'s counterpart for judge seats: the whole
1127 /// `[roles] judges` list (or every agent), untruncated and unrotated, for
1128 /// the per-seat handover when a judge's agent fails.
1129 pub judge_roster: Vec<AgentSpec>,
1130 /// Likewise for reviewer seats.
1131 pub reviewer_roster: Vec<AgentSpec>,
1132}
1133
1134/// Every array-valued key in a config table, as a dotted path.
1135///
1136/// Dotted so the error names `roles.implementers` rather than `implementers`:
1137/// an operator with three config files needs to know which key, not just that
1138/// there was one. `vars` is skipped because it is teravars' own input, merged
1139/// on purpose and never deserialised into `Config`.
1140fn array_keys(table: &toml::value::Table, prefix: &str) -> Vec<String> {
1141 let mut out = Vec::new();
1142 for (k, v) in table {
1143 if prefix.is_empty() && k == "vars" {
1144 continue;
1145 }
1146 let path = if prefix.is_empty() {
1147 k.clone()
1148 } else {
1149 format!("{prefix}.{k}")
1150 };
1151 match v {
1152 toml::Value::Array(_) => out.push(path),
1153 toml::Value::Table(t) => out.extend(array_keys(t, &path)),
1154 _ => {}
1155 }
1156 }
1157 out
1158}
1159
1160/// How an array key behaves when two config layers both declare it.
1161#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1162enum ArrayMerge {
1163 /// Two layers may both declare it; the composed value is the
1164 /// low-to-high-priority concatenation teravars already produces (see
1165 /// [`Config::load_layers`]'s doc for why that order and no dedup).
1166 Append,
1167 /// Two layers declaring it is refused; see
1168 /// [`Config::refuse_split_arrays`].
1169 Replace,
1170}
1171
1172/// The single place that decides, for a dotted array key (as returned by
1173/// [`array_keys`]), whether declaring it in two config layers is a
1174/// concatenation the operator asked for or a silent accident.
1175///
1176/// Kept as one match so the whole policy is visible in one place - the same
1177/// reason `claude_quota` and `dropped_stream` close their own classification
1178/// in one spot elsewhere in this codebase. Anything not listed defaults to
1179/// [`ArrayMerge::Replace`]: refusing is the safe default for a key nobody has
1180/// reasoned about yet, and a new array key added later has to be added here
1181/// deliberately to become appendable.
1182///
1183/// - `verify.e2e` / `verify.gate` — a "run all of these, all must exit 0"
1184/// gate. Concatenating two of them is exactly the checks both layers
1185/// wanted, which is what lets a common gate (e.g. `editorconfig-checker`)
1186/// live in a shared layer while a repository's own layer adds its own
1187/// command, instead of every repository copying the shared command into
1188/// its own file.
1189/// - `repos.roots` — a set of directories to scan for checkouts. A
1190/// repository adding its own root on top of the machine's is additive by
1191/// nature, not a replacement of where the machine looks; see
1192/// [`Repos::roots`].
1193///
1194/// Left on the refuse side, and why:
1195/// - `roles.implementers` / `roles.judges` / `roles.reviewers` — an ordered
1196/// list of *seats*, not a set. A machine's two implementers plus a
1197/// repository's one is three seats nobody asked for and nobody is paying
1198/// for on purpose.
1199/// - `notify.command` — an argv. Concatenating two argvs does not produce a
1200/// program that runs; it produces `["ntfy", "publish", "curl", "-X"]`.
1201/// - `blind.strip_lines` — technically safe to concatenate (each entry is
1202/// matched as an independent substring, so a longer list only strips
1203/// *more*), but left on the refuse side anyway: the same list also drives
1204/// `commit_msg_hook`'s generated `sed` addresses, where position matters,
1205/// and a silent three-layer merge is exactly the kind of surprise
1206/// `refuse_split_arrays` exists to catch rather than to reason about
1207/// case-by-case. A repository that wants one more stripped phrase restates
1208/// the whole list; that restatement is visible in review, an accidental
1209/// concatenation would not be.
1210fn array_merge_policy(key: &str) -> ArrayMerge {
1211 match key {
1212 "verify.e2e" | "verify.gate" | "verify.pre_gate" | "repos.roots" => ArrayMerge::Append,
1213 _ => ArrayMerge::Replace,
1214 }
1215}
1216
1217impl Config {
1218 /// Load one file through teravars: Tera rendering, `[vars]` resolution,
1219 /// and the `include = [...]` directive.
1220 pub fn load(path: &Path) -> Result<Self> {
1221 Self::load_layers(&[path.to_path_buf()])
1222 }
1223
1224 /// The Tera render context shared by every layer: `system.*` (from
1225 /// teravars), `env` (magi's own addition - a config that names a shared
1226 /// build-cache directory or a machine-specific path needs
1227 /// `{{ env.NAME | default(value='...') }}`), and `repo` / `repo_name`
1228 /// derived from the last (highest-priority) path's parent directory.
1229 ///
1230 /// Factored out so [`Config::array_provenance`] can re-render a single
1231 /// layer under the exact same context [`Config::load_layers`] uses for
1232 /// the joint render, rather than drifting from it by accident.
1233 fn render_ctx(paths: &[PathBuf]) -> teravars::Context {
1234 let mut ctx = teravars::system_context();
1235 let env: std::collections::BTreeMap<String, String> = std::env::vars().collect();
1236 ctx.insert("env", &env);
1237 if let Some(last) = paths.last()
1238 && let Some(dir) = last.parent()
1239 {
1240 ctx.insert("repo", &dir.to_string_lossy());
1241 ctx.insert(
1242 "repo_name",
1243 &dir.file_name().unwrap_or_default().to_string_lossy(),
1244 );
1245 }
1246 ctx
1247 }
1248
1249 /// Load and deep-merge a stack of config files, later files winning.
1250 ///
1251 /// This is why the config is TOML-through-teravars rather than plain serde:
1252 /// the roster is a *machine* fact (which CLIs and plans you pay for) while
1253 /// the gate is a *repository* fact (`cargo make check` here, `pnpm test`
1254 /// there). Picking one file and ignoring the other would force every repo
1255 /// to restate the roster.
1256 pub fn load_layers(paths: &[PathBuf]) -> Result<Self> {
1257 let mut engine = teravars::Engine::default();
1258 let ctx = Self::render_ctx(paths);
1259 if paths.len() > 1 {
1260 Self::refuse_split_arrays(paths, &mut engine, &ctx)?;
1261 }
1262 let merged = teravars::load_merged(paths, &mut engine, &ctx).with_context(|| {
1263 format!(
1264 "rendering config via teravars: {}",
1265 paths
1266 .iter()
1267 .map(|p| p.display().to_string())
1268 .collect::<Vec<_>>()
1269 .join(", ")
1270 )
1271 })?;
1272 let mut table = merged.config;
1273 // `[vars]` is teravars' own input, already resolved into the render
1274 // context; `deny_unknown_fields` must not trip over it.
1275 table.remove("vars");
1276 // No layer says anything about `agents`: the roster is whatever is on
1277 // `PATH` now, exactly as when no layer exists at all. An explicit
1278 // `agents = []` is a statement and is kept.
1279 let detect_agents = !table.contains_key("agents");
1280 let mut cfg: Self = toml::Value::Table(table)
1281 .try_into()
1282 .context("deserializing magi config")?;
1283 if detect_agents {
1284 cfg.agents = Self::autodetected().agents;
1285 }
1286 Ok(cfg)
1287 }
1288
1289 /// Refuse an array that two layers both declare, unless
1290 /// [`array_merge_policy`] says that key is meant to accumulate.
1291 ///
1292 /// teravars **appends** arrays when it merges layers, and that is wrong for
1293 /// most arrays magi has: `implementers` is an ordered list of seats,
1294 /// `notify.command` is an argv. Concatenating two of them yields something
1295 /// nobody wrote - three implementers out of a machine's two and a
1296 /// repository's one, or an argv of `["ntfy", "publish", "curl", "-X"]`.
1297 ///
1298 /// Replacing instead would be the right merge rule for those keys, but the
1299 /// rule lives in teravars, which several other projects depend on;
1300 /// changing it there is a decision for that crate, not something to fake
1301 /// here by re-reading the files with different semantics and hoping the
1302 /// two paths agree.
1303 ///
1304 /// So magi refuses the ambiguity rather than resolving it silently, for
1305 /// every array key except the short, deliberate list
1306 /// [`array_merge_policy`] marks [`ArrayMerge::Append`] - for those, the
1307 /// concatenation teravars already produces *is* what both files say, so
1308 /// there is nothing to refuse. The cost of guessing wrong on the refused
1309 /// keys is a roster the operator did not ask for and is paying for by the
1310 /// token; the append keys carry no such risk because every element runs
1311 /// (or every directory is scanned) regardless of order.
1312 fn refuse_split_arrays(
1313 paths: &[PathBuf],
1314 engine: &mut teravars::Engine,
1315 ctx: &teravars::Context,
1316 ) -> Result<()> {
1317 let mut seen: std::collections::BTreeMap<String, PathBuf> = Default::default();
1318 for path in paths {
1319 let one = teravars::load_merged([path], engine, ctx)
1320 .with_context(|| format!("rendering {}", path.display()))?;
1321 for key in array_keys(&one.config, "") {
1322 if array_merge_policy(&key) == ArrayMerge::Append {
1323 continue;
1324 }
1325 if let Some(first) = seen.get(&key) {
1326 bail!(
1327 "`{key}` is an array declared in two config layers:\n \
1328 {}\n {}\nteravars appends arrays when it merges, so \
1329 magi would run the concatenation of both - which is \
1330 not what either file says. Declare `{key}` in exactly \
1331 one of them.",
1332 first.display(),
1333 path.display()
1334 );
1335 }
1336 seen.insert(key, path.clone());
1337 }
1338 }
1339 Ok(())
1340 }
1341
1342 /// Which layers contributed to a composed, appendable array key (e.g.
1343 /// `"verify.gate"`), in the same low-to-high-priority order
1344 /// [`Config::load_layers`] concatenates them in. Layers that do not
1345 /// declare `key` at all are omitted.
1346 ///
1347 /// This is a **display aid for `magi doctor` only.** The command list
1348 /// that actually runs always comes from the one joint
1349 /// [`teravars::load_merged`] call in `load_layers`, never from this
1350 /// function - the exact hazard [`Config::refuse_split_arrays`] warns
1351 /// about is two merge paths that might disagree, so this function must
1352 /// never become a second source of the *composed* value, only of which
1353 /// file wrote which line in it.
1354 ///
1355 /// Re-rendering each layer alone can, in principle, resolve a
1356 /// `{{ vars.x }}` differently than the joint render would, if `x` is
1357 /// defined in one layer and referenced in another - the same caveat
1358 /// `refuse_split_arrays`'s structural, key-only check already lives with.
1359 /// None of magi's own gate commands cross that line, and a doctor listing
1360 /// is read by a human who can compare it against the joint one printed
1361 /// alongside it, so this is judged worth the simplicity of not
1362 /// threading provenance through the real load path.
1363 pub fn array_provenance(paths: &[PathBuf], key: &str) -> Vec<(PathBuf, Vec<String>)> {
1364 let mut engine = teravars::Engine::default();
1365 let ctx = Self::render_ctx(paths);
1366 let mut out = Vec::new();
1367 for path in paths {
1368 let Ok(one) = teravars::load_merged([path], &mut engine, &ctx) else {
1369 continue;
1370 };
1371 let mut cur = &one.config;
1372 let mut found = None;
1373 let parts: Vec<&str> = key.split('.').collect();
1374 for (i, part) in parts.iter().enumerate() {
1375 match cur.get(*part) {
1376 Some(toml::Value::Array(a)) if i == parts.len() - 1 => {
1377 found = Some(a);
1378 break;
1379 }
1380 Some(toml::Value::Table(t)) => cur = t,
1381 _ => break,
1382 }
1383 }
1384 let Some(values) = found else { continue };
1385 let strings: Vec<String> = values
1386 .iter()
1387 .filter_map(|v| v.as_str().map(str::to_owned))
1388 .collect();
1389 if !strings.is_empty() {
1390 out.push((path.clone(), strings));
1391 }
1392 }
1393 out
1394 }
1395
1396 /// Each layer rendered on its own, with the outcome per file: the
1397 /// settings screen's way of saying which layer a value came from and which
1398 /// layer is the one that does not parse. A **display aid only**, for the
1399 /// same reason as [`Config::array_provenance`]: the effective config
1400 /// always comes from the one joint [`Config::load_layers`].
1401 pub(crate) fn layer_tables(paths: &[PathBuf]) -> Vec<(PathBuf, Result<toml::Table>)> {
1402 let mut engine = teravars::Engine::default();
1403 let ctx = Self::render_ctx(paths);
1404 paths
1405 .iter()
1406 .map(|path| {
1407 let one = teravars::load_merged([path], &mut engine, &ctx)
1408 .map(|m| m.config)
1409 .with_context(|| format!("rendering {}", path.display()));
1410 (path.clone(), one)
1411 })
1412 .collect()
1413 }
1414
1415 /// Render a composed command list for `magi doctor`: the joined command
1416 /// line the run actually uses, plus - only when more than one layer
1417 /// contributed - which layer wrote which line.
1418 ///
1419 /// A single contributing layer (the common case today) stays the plain
1420 /// one-line summary magi has always printed, `empty` included: that
1421 /// honest "(none — ...)" is what caught a real gate-composition gap
1422 /// before this array could compose at all, and composition should not
1423 /// make the common case noisier.
1424 pub fn describe_composed(
1425 paths: &[PathBuf],
1426 commands: &[String],
1427 key: &str,
1428 empty: &str,
1429 ) -> String {
1430 if commands.is_empty() {
1431 return empty.to_owned();
1432 }
1433 let joined = commands.join(" && ");
1434 let provenance = Self::array_provenance(paths, key);
1435 if provenance.len() <= 1 {
1436 return joined;
1437 }
1438 let mut out = joined;
1439 for (path, cmds) in &provenance {
1440 out.push_str(&format!("\n [{}] {}", path.display(), cmds.join(" && ")));
1441 }
1442 out
1443 }
1444
1445 /// Resolve the config for `repo`, honouring an explicit `--config` path.
1446 ///
1447 /// Returns the config and the layers it came from, empty for built-in
1448 /// defaults.
1449 pub fn discover(repo: &Path, explicit: Option<&Path>) -> Result<(Self, Vec<PathBuf>)> {
1450 if let Some(p) = explicit {
1451 let paths = vec![p.to_path_buf()];
1452 return Ok((Self::load_layers(&paths)?, paths));
1453 }
1454 let paths = Self::layers(repo);
1455 if paths.is_empty() {
1456 return Ok((Self::autodetected(), paths));
1457 }
1458 Ok((Self::load_layers(&paths)?, paths))
1459 }
1460 /// Environment variable that relocates the machine-wide config layer.
1461 ///
1462 /// Set it to a directory and magi reads `<dir>/magi/config.toml` instead
1463 /// of the one under [`dirs::config_dir`]; set it to the empty string and
1464 /// magi reads no machine layer at all.
1465 ///
1466 /// This exists because the machine layer is otherwise unavoidable, and a
1467 /// test that builds a config fixture is not asking for the operator's
1468 /// preferences to be merged into it. Adding `[repos] roots` to the real
1469 /// machine config on a development box turned two passing tests red -
1470 /// `repos_list_returns_name_and_path_for_every_configured_root` and
1471 /// `repos_list_only_rescans_within_the_ttl_when_asked_to`, whose fixtures
1472 /// declare `[repos] roots` of their own, which [`Config::layers`] then
1473 /// found in two layers and [`Config::refuse_split_arrays`] correctly
1474 /// refused. CI never saw it: a runner has no machine config, so the suite
1475 /// was green there and red only where somebody actually uses magi.
1476 ///
1477 /// An operator gets the same escape hatch for free: a second machine
1478 /// config, or none, without moving files about.
1479 pub const CONFIG_DIR_ENV: &str = "MAGI_CONFIG_DIR";
1480
1481 /// Every config layer that applies to `repo`, in increasing precedence.
1482 ///
1483 /// The machine layer is whatever [`Config::machine_layer`] resolves to,
1484 /// which is nothing at all in a test build.
1485 pub fn layers(repo: &Path) -> Vec<PathBuf> {
1486 let mut paths = Vec::new();
1487 paths.extend(Self::machine_layer());
1488 paths.push(repo.join(".magi").join("config.toml"));
1489 paths.push(repo.join("magi.toml"));
1490 paths.retain(|p| p.is_file());
1491 paths
1492 }
1493
1494 /// The machine-wide layer's path, when there is one.
1495 ///
1496 /// **A test build has none unless it names one.** A fixture is a complete
1497 /// statement of the config under test, and the operator's own preferences
1498 /// have no business being merged into it - least of all silently, on one
1499 /// machine, in a suite that is green everywhere else.
1500 #[cfg(test)]
1501 pub(crate) fn machine_layer() -> Option<PathBuf> {
1502 std::env::var(Self::CONFIG_DIR_ENV)
1503 .ok()
1504 .filter(|dir| !dir.trim().is_empty())
1505 .map(|dir| PathBuf::from(dir).join("magi").join("config.toml"))
1506 }
1507
1508 /// The machine-wide layer's path, when there is one.
1509 #[cfg(not(test))]
1510 pub(crate) fn machine_layer() -> Option<PathBuf> {
1511 match std::env::var(Self::CONFIG_DIR_ENV) {
1512 // Named, and empty on purpose: no machine layer.
1513 Ok(dir) if dir.trim().is_empty() => None,
1514 Ok(dir) => Some(PathBuf::from(dir).join("magi").join("config.toml")),
1515 Err(_) => dirs::config_dir().map(|dir| dir.join("magi").join("config.toml")),
1516 }
1517 }
1518
1519 /// Built-in config whose roster is the agent CLIs found on `PATH`.
1520 pub fn autodetected() -> Self {
1521 let mut cfg = Self::default();
1522 for (kind, id, model) in [
1523 (AgentKind::Claude, "opus", Some("opus")),
1524 (AgentKind::Claude, "sonnet", Some("sonnet")),
1525 (AgentKind::Antigravity, "antigravity", None),
1526 (AgentKind::Opencode, "opencode", None),
1527 (AgentKind::Codex, "codex", None),
1528 (AgentKind::Omp, "omp", None),
1529 ] {
1530 if kind.program().is_some_and(which) && !cfg.agents.iter().any(|a| a.id == id) {
1531 cfg.agents.push(AgentSpec {
1532 id: id.to_owned(),
1533 kind,
1534 model: model.map(str::to_owned),
1535 command: Vec::new(),
1536 extra_args: Vec::new(),
1537 env: BTreeMap::new(),
1538 prompt_delivery: None,
1539 });
1540 }
1541 }
1542 cfg
1543 }
1544
1545 /// The shared build cache the verify commands and the agents both build
1546 /// into, when the config declares one. See [`Verify::cache_dir`].
1547 pub fn cache_dir(&self) -> Option<PathBuf> {
1548 self.verify.cache_dir()
1549 }
1550
1551 /// Look an agent up by id.
1552 pub fn agent(&self, id: &str) -> Result<&AgentSpec> {
1553 self.agents
1554 .iter()
1555 .find(|a| a.id == id)
1556 .with_context(|| format!("no agent with id `{id}` in the roster"))
1557 }
1558
1559 /// Rotate `count` seats out of `ids`, or out of the whole roster at
1560 /// `offset` when `ids` is empty.
1561 ///
1562 /// The one rotation rule - explicit ids cycle, an empty list rotates the
1563 /// roster - shared by every seat count [`Config::resolve_roles`] fills in,
1564 /// rather than each seat reimplementing it and drifting apart.
1565 fn rotate(&self, ids: &[String], count: usize, offset: usize) -> Result<Vec<AgentSpec>> {
1566 let mut out = Vec::with_capacity(count);
1567 for i in 0..count {
1568 let spec = if ids.is_empty() {
1569 self.agents[(i + offset) % self.agents.len()].clone()
1570 } else {
1571 self.agent(&ids[i % ids.len()])?.clone()
1572 };
1573 out.push(spec);
1574 }
1575 Ok(out)
1576 }
1577
1578 /// `ids`, resolved to specs in the order named, or the whole `[[agents]]`
1579 /// roster in file order when `ids` is empty — the same "explicit ids
1580 /// stand alone, an empty list means the whole roster" rule [`Self::rotate`]
1581 /// applies, but with no `count` to truncate to and no `offset` to wrap by.
1582 /// See [`ResolvedRoles::implementer_roster`] for why a truncated, rotated
1583 /// list cannot answer the question this exists for.
1584 fn full_roster(&self, ids: &[String]) -> Result<Vec<AgentSpec>> {
1585 if ids.is_empty() {
1586 Ok(self.agents.clone())
1587 } else {
1588 ids.iter().map(|id| self.agent(id).cloned()).collect()
1589 }
1590 }
1591
1592 /// Fill the roles out to the configured widths.
1593 ///
1594 /// An empty role list rotates through the whole roster, so a three-agent
1595 /// roster with `candidates = 3` gives one implementation per agent, and
1596 /// `judges = 3` rotates the judge seats by one so that judge *i* is not the
1597 /// author of candidate *i* whenever the roster has more than one agent.
1598 pub fn resolve_roles(&self) -> Result<ResolvedRoles> {
1599 if self.agents.is_empty() {
1600 bail!(
1601 "agent roster is empty: no agent CLI found on PATH and no \
1602 [[agents]] in the config. Run `magi init` to write a starter \
1603 magi.toml."
1604 );
1605 }
1606 Ok(ResolvedRoles {
1607 implementers: self.rotate(&self.roles.implementers, self.graph.candidates, 0)?,
1608 judges: self.rotate(&self.roles.judges, self.graph.judges, 1)?,
1609 reviewers: self.rotate(&self.roles.reviewers, self.graph.reviewers, 0)?,
1610 fixer: self
1611 .roles
1612 .fixer
1613 .as_deref()
1614 .map(|f| self.agent(f).cloned())
1615 .transpose()?,
1616 // Role resolution validates roster shape, but deliberately does
1617 // not preflight a CLI. The other graph seats have always deferred
1618 // that failure to invocation; doing it only for the conductor
1619 // made otherwise usable graph commands and `doctor` fail as one.
1620 conductor: match self.roles.conductor.as_ref().map(AgentChoice::ids) {
1621 Some(ids) if ids.len() == 1 => self.agent(ids[0])?.clone(),
1622 // A fallback chain: the first id the roster knows. The rest
1623 // are `agent::pick_chain`'s business at invocation.
1624 Some(ids) if !ids.is_empty() => ids
1625 .iter()
1626 .find_map(|id| self.agent(id).ok())
1627 .cloned()
1628 .with_context(|| {
1629 format!("[roles] conductor names no agent in the roster: {ids:?}")
1630 })?,
1631 // Keep the normal standalone-seat preference when something
1632 // is installed, but retain a roster fallback when it is not.
1633 // Invocation then reports the unavailable CLI in the same
1634 // place it does for every other graph role.
1635 _ => crate::agent::pick(&self.agents, None, &crate::agent::installed)
1636 .unwrap_or_else(|_| self.agents[0].clone()),
1637 },
1638 implementer_roster: self.full_roster(&self.roles.implementers)?,
1639 judge_roster: self.full_roster(&self.roles.judges)?,
1640 reviewer_roster: self.full_roster(&self.roles.reviewers)?,
1641 })
1642 }
1643
1644 /// Advisor seats for the design-deliberation stage (see
1645 /// `graph::Runner::advise`): `[roles] advisors` when set, otherwise the
1646 /// judge roster - see [`Roles::advisors`] for why that fallback and not
1647 /// the whole roster.
1648 ///
1649 /// The fallback rotates with `offset = 1`, matching the judges line in
1650 /// [`Config::resolve_roles`] exactly, `ids` and offset both - not just
1651 /// `roles.judges`, which is empty whenever judges themselves are
1652 /// unconfigured and rotating the whole roster. Falling back with
1653 /// `offset = 0` there would silently hand the advisors a *different*
1654 /// agent set than the judges an unconfigured run would actually get,
1655 /// which is the one thing [`Roles::advisors`]'s doc promises will not
1656 /// happen.
1657 ///
1658 /// Called lazily from the graph node itself rather than folded into
1659 /// [`Config::resolve_roles`]: unlike the other roles, a failure here must
1660 /// not stop a run from starting at all - the deliberation stage is an
1661 /// enrichment `[graph] advise` can turn off, not a seat later nodes
1662 /// cannot proceed without - and at the point `resolve_roles` runs (before
1663 /// [`crate::run::RunState`] exists, on `Runner::start`) there would be no
1664 /// run yet for a resolution failure to be reported against.
1665 pub fn advisors(&self) -> Result<Vec<AgentSpec>> {
1666 if self.agents.is_empty() {
1667 bail!(
1668 "agent roster is empty: no agent CLI found on PATH and no \
1669 [[agents]] in the config. Run `magi init` to write a starter \
1670 magi.toml."
1671 );
1672 }
1673 if !self.roles.advisors.is_empty() {
1674 return self.rotate(&self.roles.advisors, self.graph.advisors, 0);
1675 }
1676 self.rotate(&self.roles.judges, self.graph.advisors, 1)
1677 }
1678
1679 /// The untruncated roster advisor seats hand over along: `[roles]
1680 /// advisors` when set, otherwise the judges' roster, exactly as
1681 /// [`Self::advisors`] chooses its own list.
1682 pub fn advisor_roster(&self) -> Result<Vec<AgentSpec>> {
1683 if self.roles.advisors.is_empty() {
1684 self.full_roster(&self.roles.judges)
1685 } else {
1686 self.full_roster(&self.roles.advisors)
1687 }
1688 }
1689
1690 /// Shell prefix for [`Verify`] commands.
1691 pub fn shell(&self) -> Vec<String> {
1692 if let Some(s) = &self.verify.shell {
1693 return s.clone();
1694 }
1695 if which("sh") {
1696 vec!["sh".to_owned(), "-c".to_owned()]
1697 } else {
1698 vec!["cmd".to_owned(), "/C".to_owned()]
1699 }
1700 }
1701
1702 /// Starter config, as written by `magi init`.
1703 pub fn starter_toml() -> String {
1704 let detected = Self::autodetected();
1705 let mut s = String::from(
1706 "# magi — blind multi-agent implementation competition.\n\
1707 # `magi run \"<task>\"` walks: implement (N parallel worktrees)\n\
1708 # -> blind judging -> deliberation -> private final vote\n\
1709 # -> fold losers -> review + E2E loop -> gate -> merge.\n\
1710 #\n\
1711 # Rendered by teravars: a `[vars]` table, env\n\
1712 # and system lookups, and `include = [...]` all work. Tera\n\
1713 # braces are live everywhere in this file, but comments are\n\
1714 # stripped before rendering (teravars >= 0.2.2), so a comment\n\
1715 # may quote `{{ ... }}` freely.\n\
1716 #\n\
1717 # Layers deep-merge in increasing\n\
1718 # precedence, so the roster can live once per machine in\n\
1719 # <config_dir>/magi/config.toml and each repo only states its own\n\
1720 # gate:\n\
1721 # <config_dir>/magi/config.toml < .magi/config.toml < magi.toml\n\n\
1722 [vars]\n\
1723 # Reference it as vars.cache inside Tera braces, anywhere below.\n\
1724 # Single quotes inside the braces: teravars renders the raw file\n\
1725 # text, so TOML's own \\\" escaping never reaches Tera.\n\
1726 cache = \"{{ env.MAGI_CACHE | default(value='/tmp') }}\"\n\n",
1727 );
1728 if detected.agents.is_empty() {
1729 s.push_str(
1730 "# No agent CLI was found on PATH. Fill this in by hand.\n\
1731 # kind = claude | opencode | antigravity | codex | command\n\
1732 [[agents]]\nid = \"opus\"\nkind = \"claude\"\nmodel = \"opus\"\n\n",
1733 );
1734 } else {
1735 for a in &detected.agents {
1736 s.push_str("[[agents]]\n");
1737 s.push_str(&format!("id = {:?}\n", a.id));
1738 s.push_str(&format!("kind = {:?}\n", a.kind.as_str()));
1739 if let Some(m) = &a.model {
1740 s.push_str(&format!("model = {m:?}\n"));
1741 }
1742 s.push('\n');
1743 }
1744 }
1745 s.push_str(
1746 "# Leave a role list empty to rotate through the roster.\n\
1747 [roles]\n\
1748 implementers = []\n\
1749 judges = []\n\
1750 reviewers = []\n\
1751 # conductor = \"opus\" # arranges the queue; unset picks a seat like chatter does\n\
1752 # synthesizer = \"opus\" # blends the advisors into one brief; unset picks a seat like chatter does\n\
1753 # synthesizer = [\"opus\", \"codex\"] # array form: fallback chain, each tried once on quota or failure\n\n\
1754 [graph]\n\
1755 candidates = 3\n\
1756 judges = 3\n\
1757 deliberate_rounds = 1\n\
1758 reviewers = 3\n\
1759 review_rounds = 6\n\
1760 # Fix rounds a failing verify.gate gets before the run is blocked (0 = none).\n\
1761 gate_fix_rounds = 1\n\
1762 max_parallel = 4\n\
1763 language = \"en\"\n\
1764 # One CLI conversation per seat: judges keep their own argument\n\
1765 # across deliberation, the fixer keeps its implementation context.\n\
1766 sessions = true\n\
1767 # Reviewer-seat timeout. When timeout_verify is omitted, E2E and\n\
1768 # the final gate inherit this value for compatibility.\n\
1769 timeout_review = 1200\n\
1770 # Optional independent E2E/final-gate timeout; uncomment to keep\n\
1771 # verification independent if timeout_review changes later.\n\
1772 # timeout_verify = 1200\n\n\
1773 [verify]\n\
1774 # Run once per review round in the winner's worktree; failures are\n\
1775 # fed back to the fixer.\n\
1776 e2e = []\n\
1777 # Final gate. Every command must exit 0 before a merge.\n\
1778 gate = []\n\
1779 # Mechanical fixers (formatters) run in the winner's worktree just\n\
1780 # before the gate; whatever they change becomes one commit. A failing\n\
1781 # command only warns - the gate stays the arbiter. Same timeout as the\n\
1782 # gate (timeout_verify). Keep it light and idempotent.\n\
1783 # pre_gate = []\n\n\
1784 [merge]\n\
1785 # none | local | pr\n\
1786 mode = \"none\"\n\
1787 # release_bump = true # Rust (Cargo.toml) repositories only; a no-op elsewhere\n\n\
1788 [update]\n\
1789 # off | notify | install — checked in the background, throttled.\n\
1790 mode = \"notify\"\n\
1791 # interval = \"24h\"\n\n\
1792 [daemon]\n\
1793 # Minutes a release-bump pull request (chore/release-v*) may sit with\n\
1794 # no new commit and no check changing state before `magi serve`\n\
1795 # notices and asks you. A failed check is rerun once on its own;\n\
1796 # still red after that escalates at once. 0 turns the watcher off.\n\
1797 # release_stall_minutes = 60\n",
1798 );
1799 s
1800 }
1801}
1802
1803/// Is `program` on `PATH`?
1804pub fn which(program: &str) -> bool {
1805 find_program(program).is_some()
1806}
1807
1808/// The file a bare `program` name resolves to on `PATH`, the way the OS shell
1809/// would find it.
1810///
1811/// Spawn agents through this, not by bare name: on Windows Rust's std
1812/// only tries `name.exe`, so a CLI installed as an npm `.cmd` shim (codex
1813/// since its 2026-09-23 reinstall) is "not found" even though a shell runs it.
1814/// On Windows an extensionless file is never a match: npm writes an `sh`
1815/// script beside every `.cmd` shim, and spawning that fails with os error 193.
1816pub fn find_program(program: &str) -> Option<PathBuf> {
1817 find_program_on(program, &std::env::var_os("PATH")?)
1818}
1819
1820/// [`find_program`] against an explicit `PATH`, for a child whose environment
1821/// overrides it.
1822pub fn find_program_on(program: &str, paths: &std::ffi::OsStr) -> Option<PathBuf> {
1823 let pathext = std::env::var("PATHEXT").unwrap_or_else(|_| ".EXE;.CMD;.BAT".into());
1824 find_program_in(program, paths, cfg!(windows).then_some(pathext.as_str()))
1825}
1826
1827fn find_program_in(
1828 program: &str,
1829 paths: &std::ffi::OsStr,
1830 pathext: Option<&str>,
1831) -> Option<PathBuf> {
1832 let p = Path::new(program);
1833 if p.components().count() > 1 {
1834 return p.is_file().then(|| p.to_path_buf());
1835 }
1836 std::env::split_paths(paths).find_map(|dir| match pathext {
1837 Some(exts) => {
1838 let bare = dir.join(program);
1839 if p.extension().is_some() && bare.is_file() {
1840 return Some(bare);
1841 }
1842 exts.split(';')
1843 .filter(|e| !e.is_empty())
1844 .map(|e| dir.join(format!("{program}{}", e.to_lowercase())))
1845 .find(|c| c.is_file())
1846 }
1847 None => Some(dir.join(program)).filter(|c| c.is_file()),
1848 })
1849}
1850
1851#[cfg(test)]
1852mod tests {
1853 #[test]
1854 fn context_window_prefers_exact_then_longest_prefix_and_user_over_builtin() {
1855 let mut cfg = Config::default();
1856 assert_eq!(
1857 cfg.context_window("claude-sonnet-4-5-20250929"),
1858 Some(200_000)
1859 );
1860 assert_eq!(cfg.context_window("gpt-4.1-mini"), Some(1_000_000));
1861 assert_eq!(cfg.context_window("mystery-model"), None);
1862 cfg.context_windows
1863 .insert("claude-sonnet-4-5".into(), 1_000_000);
1864 cfg.context_windows.insert("claude-sonnet-4".into(), 5);
1865 cfg.context_windows.insert("mystery".into(), 32_768);
1866 // Longest user prefix beats a shorter one and the built-in table.
1867 assert_eq!(
1868 cfg.context_window("claude-sonnet-4-5-20250929"),
1869 Some(1_000_000)
1870 );
1871 // An exact name beats any prefix.
1872 cfg.context_windows
1873 .insert("claude-sonnet-4-5-20250929".into(), 7);
1874 assert_eq!(cfg.context_window("claude-sonnet-4-5-20250929"), Some(7));
1875 assert_eq!(cfg.context_window("mystery-model"), Some(32_768));
1876 }
1877
1878 use super::*;
1879
1880 /// npm writes an extensionless `sh` script beside `codex.cmd`; on Windows
1881 /// the `.cmd` is the spawnable one (os error 193 otherwise, 2026-09-23).
1882 #[test]
1883 fn windows_lookup_picks_the_cmd_shim_over_the_extensionless_script() {
1884 let dir = tempfile::tempdir().unwrap();
1885 std::fs::write(dir.path().join("codex"), "#!/bin/sh\n").unwrap();
1886 std::fs::write(dir.path().join("codex.cmd"), "@echo off\n").unwrap();
1887 let paths = dir.path().as_os_str();
1888 assert_eq!(
1889 find_program_in("codex", paths, Some(".EXE;.CMD")),
1890 Some(dir.path().join("codex.cmd"))
1891 );
1892 assert_eq!(
1893 find_program_in("codex", paths, None),
1894 Some(dir.path().join("codex"))
1895 );
1896 assert_eq!(find_program_in("claude", paths, Some(".EXE;.CMD")), None);
1897 }
1898
1899 fn spec(id: &str) -> AgentSpec {
1900 AgentSpec {
1901 id: id.to_owned(),
1902 kind: AgentKind::Command,
1903 model: None,
1904 command: vec!["true".to_owned()],
1905 extra_args: Vec::new(),
1906 env: BTreeMap::new(),
1907 prompt_delivery: None,
1908 }
1909 }
1910
1911 #[test]
1912 fn timeout_verify_omitted_from_old_toml_inherits_timeout_review() {
1913 // `timeout_verify` used to not exist: `verify.e2e`/`verify.gate` ran
1914 // under `timeout_review`. A config written before this field existed
1915 // must run exactly as before, which means its default has to be the
1916 // same 1200s `timeout_review` has always defaulted to.
1917 let g: Graph = toml::from_str("timeout_review = 3600").expect("parse");
1918 assert_eq!(g.timeout_verify, None);
1919 assert_eq!(g.verify_timeout(), 3600);
1920 }
1921
1922 #[test]
1923 fn shrinking_timeout_review_does_not_shrink_timeout_verify() {
1924 // The bug this field exists to close: `[graph] timeout_review = 45`
1925 // used to shrink the real-machine `verify.e2e`/`verify.gate` budget
1926 // along with the reviewer seats' own timeout, because both read the
1927 // same field.
1928 let g: Graph = toml::from_str("timeout_review = 45").expect("parse");
1929 assert_eq!(g.timeout_review, 45);
1930 assert_eq!(
1931 g.verify_timeout(),
1932 45,
1933 "an omitted legacy value follows review"
1934 );
1935 let explicit: Graph = toml::from_str("timeout_review = 45\ntimeout_verify = 1200")
1936 .expect("parse explicit override");
1937 assert_eq!(explicit.verify_timeout(), 1200);
1938 }
1939
1940 #[test]
1941 fn a_toml_layer_written_before_these_fields_existed_still_parses() {
1942 // `deny_unknown_fields` cuts both ways: a config from before
1943 // `timeout_verify`/`e2e_every_round` existed must still parse, with
1944 // both defaulted rather than refused as unknown-in-reverse.
1945 let g: Graph =
1946 toml::from_str("candidates = 1\nreviewers = 3\nreview_rounds = 6\nmax_parallel = 4\n")
1947 .expect("an old-shaped [graph] table must still parse");
1948 assert_eq!(g.verify_timeout(), Graph::default().timeout_review);
1949 assert!(
1950 !g.e2e_every_round,
1951 "off by default, same as before this field existed"
1952 );
1953 }
1954
1955 #[test]
1956 fn empty_roles_rotate_judges_off_their_own_candidate() {
1957 // Three seats, said out loud: this is a test about *rotation*, and it
1958 // has nothing to say about how many candidates a task buys by default.
1959 let cfg = Config {
1960 agents: vec![spec("a"), spec("b"), spec("c")],
1961 graph: Graph {
1962 candidates: 3,
1963 ..Graph::default()
1964 },
1965 ..Config::default()
1966 };
1967 let roles = cfg.resolve_roles().unwrap();
1968 let impls: Vec<&str> = roles.implementers.iter().map(|a| a.id.as_str()).collect();
1969 let judges: Vec<&str> = roles.judges.iter().map(|a| a.id.as_str()).collect();
1970 assert_eq!(impls, ["a", "b", "c"]);
1971 assert_eq!(judges, ["b", "c", "a"]);
1972 for (i, j) in judges.iter().enumerate() {
1973 assert_ne!(*j, impls[i], "judge {i} must not sit on its own candidate");
1974 }
1975 }
1976
1977 #[test]
1978 fn single_agent_roster_fills_every_seat() {
1979 let cfg = Config {
1980 agents: vec![spec("solo")],
1981 graph: Graph {
1982 candidates: 3,
1983 ..Graph::default()
1984 },
1985 ..Config::default()
1986 };
1987 let roles = cfg.resolve_roles().unwrap();
1988 assert_eq!(roles.implementers.len(), 3);
1989 assert!(roles.judges.iter().all(|a| a.id == "solo"));
1990 }
1991
1992 #[test]
1993 fn implementer_roster_is_the_whole_agent_list_untruncated_when_unset() {
1994 // `candidates = 1` (a solo run) still resolves `implementers` down to
1995 // one slot, but `implementer_roster` must carry every agent in the
1996 // roster, in file order, for `graph::Runner`'s quota fallback to walk
1997 // forward through once that one slot's agent runs out of quota.
1998 let cfg = Config {
1999 agents: vec![spec("a"), spec("b"), spec("c")],
2000 graph: Graph {
2001 candidates: 1,
2002 ..Graph::default()
2003 },
2004 ..Config::default()
2005 };
2006 let roles = cfg.resolve_roles().unwrap();
2007 assert_eq!(roles.implementers.len(), 1);
2008 let roster: Vec<&str> = roles
2009 .implementer_roster
2010 .iter()
2011 .map(|a| a.id.as_str())
2012 .collect();
2013 assert_eq!(roster, ["a", "b", "c"]);
2014 }
2015
2016 #[test]
2017 fn implementer_roster_follows_explicit_ids_in_the_order_named() {
2018 let cfg = Config {
2019 agents: vec![spec("a"), spec("b"), spec("c")],
2020 roles: Roles {
2021 implementers: vec!["c".to_owned(), "a".to_owned()],
2022 ..Roles::default()
2023 },
2024 graph: Graph {
2025 candidates: 1,
2026 ..Graph::default()
2027 },
2028 ..Config::default()
2029 };
2030 let roles = cfg.resolve_roles().unwrap();
2031 // Unaffected by the new field: still just the first named id.
2032 assert_eq!(roles.implementers.len(), 1);
2033 assert_eq!(roles.implementers[0].id, "c");
2034 let roster: Vec<&str> = roles
2035 .implementer_roster
2036 .iter()
2037 .map(|a| a.id.as_str())
2038 .collect();
2039 assert_eq!(roster, ["c", "a"]);
2040 }
2041
2042 #[test]
2043 fn explicit_roles_win() {
2044 let cfg = Config {
2045 agents: vec![spec("a"), spec("b")],
2046 roles: Roles {
2047 implementers: vec!["b".to_owned()],
2048 judges: vec!["a".to_owned()],
2049 reviewers: Vec::new(),
2050 fixer: Some("a".to_owned()),
2051 ..Roles::default()
2052 },
2053 ..Config::default()
2054 };
2055 let roles = cfg.resolve_roles().unwrap();
2056 assert!(roles.implementers.iter().all(|a| a.id == "b"));
2057 assert!(roles.judges.iter().all(|a| a.id == "a"));
2058 assert_eq!(roles.fixer.unwrap().id, "a");
2059 assert_eq!(roles.conductor.id, "a");
2060 }
2061
2062 #[test]
2063 fn unknown_agent_id_is_an_error() {
2064 let cfg = Config {
2065 agents: vec![spec("a")],
2066 roles: Roles {
2067 judges: vec!["nope".to_owned()],
2068 ..Roles::default()
2069 },
2070 ..Config::default()
2071 };
2072 assert!(cfg.resolve_roles().is_err());
2073 }
2074
2075 #[test]
2076 fn conductor_role_is_resolved_validated_and_has_a_fallback() {
2077 let mut cfg = Config {
2078 agents: vec![spec("a"), spec("b")],
2079 ..Config::default()
2080 };
2081 assert_eq!(cfg.resolve_roles().unwrap().conductor.id, "a");
2082
2083 cfg.roles.conductor = Some("b".into());
2084 assert_eq!(cfg.resolve_roles().unwrap().conductor.id, "b");
2085
2086 cfg.roles.conductor = Some("missing".into());
2087 assert!(cfg.resolve_roles().is_err());
2088 }
2089
2090 #[test]
2091 fn a_standalone_role_takes_a_string_or_an_array_and_round_trips() {
2092 let one: Roles = toml::from_str("synthesizer = \"opus\"").unwrap();
2093 assert_eq!(one.synthesizer, Some(AgentChoice::One("opus".to_owned())));
2094 assert_eq!(primary(one.synthesizer.as_ref()), Some("opus"));
2095
2096 let chain: Roles = toml::from_str("chatter = [\"opus\", \"codex\"]").unwrap();
2097 assert_eq!(chain.chatter.as_ref().unwrap().ids(), ["opus", "codex"]);
2098 assert_eq!(primary(chain.chatter.as_ref()), Some("opus"));
2099
2100 for roles in [one, chain] {
2101 let text = toml::to_string(&roles).unwrap();
2102 let back: Roles = toml::from_str(&text).unwrap();
2103 assert_eq!(back.synthesizer, roles.synthesizer);
2104 assert_eq!(back.chatter, roles.chatter);
2105 }
2106 let text = toml::to_string(&Roles {
2107 conductor: Some("x".into()),
2108 ..Roles::default()
2109 })
2110 .unwrap();
2111 assert!(
2112 text.contains("conductor = \"x\""),
2113 "string stays a string: {text}"
2114 );
2115 assert!(toml::from_str::<Roles>("synthesizer = 3").is_err());
2116 }
2117
2118 #[test]
2119 fn an_empty_choice_counts_as_unset() {
2120 assert!(AgentChoice::Chain(Vec::new()).ids().is_empty());
2121 assert!(AgentChoice::One(" ".to_owned()).ids().is_empty());
2122 assert_eq!(primary(Some(&AgentChoice::Chain(vec![]))), None);
2123 }
2124
2125 #[test]
2126 fn synthesizer_role_is_a_lazy_lookup_with_the_same_fallback_as_chatter() {
2127 // Unlike `conductor`, `synthesizer` is never validated by
2128 // `resolve_roles` — it is looked up lazily by
2129 // `graph::Runner::synthesize_brief` the same way `[roles] chatter`
2130 // is looked up by `talk::begin`, so this exercises `agent::pick`
2131 // directly instead of going through `resolve_roles`.
2132 let mut cfg = Config {
2133 agents: vec![spec("a"), spec("b")],
2134 ..Config::default()
2135 };
2136 let want = primary(cfg.roles.synthesizer.as_ref());
2137 assert_eq!(
2138 crate::agent::pick(&cfg.agents, want, &crate::agent::installed)
2139 .unwrap()
2140 .id,
2141 "a",
2142 "unset falls back to agent::pick's own default order"
2143 );
2144
2145 cfg.roles.synthesizer = Some("b".into());
2146 let want = primary(cfg.roles.synthesizer.as_ref());
2147 assert_eq!(
2148 crate::agent::pick(&cfg.agents, want, &crate::agent::installed)
2149 .unwrap()
2150 .id,
2151 "b",
2152 "the named agent wins over the default order"
2153 );
2154 }
2155
2156 #[test]
2157 fn empty_roster_is_an_error() {
2158 assert!(Config::default().resolve_roles().is_err());
2159 }
2160
2161 #[test]
2162 fn advise_defaults_to_on_with_three_proposals() {
2163 let g = Graph::default();
2164 assert!(g.advise);
2165 assert_eq!(g.advisors, 3);
2166 }
2167
2168 #[test]
2169 fn unset_advisors_falls_back_to_the_judge_roster() {
2170 let cfg = Config {
2171 agents: vec![spec("a"), spec("b")],
2172 roles: Roles {
2173 judges: vec!["b".to_owned()],
2174 ..Roles::default()
2175 },
2176 graph: Graph {
2177 advisors: 2,
2178 ..Graph::default()
2179 },
2180 ..Config::default()
2181 };
2182 let advisors = cfg.advisors().expect("advisors resolve");
2183 assert_eq!(advisors.len(), 2);
2184 assert!(
2185 advisors.iter().all(|a| a.id == "b"),
2186 "an unset [roles] advisors must fall back to [roles] judges: {advisors:?}"
2187 );
2188 }
2189
2190 #[test]
2191 fn an_explicit_advisor_roster_wins_over_the_judge_fallback() {
2192 let cfg = Config {
2193 agents: vec![spec("a"), spec("b")],
2194 roles: Roles {
2195 judges: vec!["b".to_owned()],
2196 advisors: vec!["a".to_owned()],
2197 ..Roles::default()
2198 },
2199 graph: Graph {
2200 advisors: 2,
2201 ..Graph::default()
2202 },
2203 ..Config::default()
2204 };
2205 let advisors = cfg.advisors().expect("advisors resolve");
2206 assert!(advisors.iter().all(|a| a.id == "a"));
2207 }
2208
2209 /// Neither `[roles] advisors` nor `[roles] judges` set: an unconfigured
2210 /// advisor roster must resolve to the exact same agents an unconfigured
2211 /// judge panel would get - same ids, same rotation offset - or the
2212 /// promise in [`Roles::advisors`]'s doc ("advisor diversity for free")
2213 /// does not actually hold.
2214 #[test]
2215 fn an_unconfigured_advisor_and_judge_roster_resolve_to_the_same_agents() {
2216 let cfg = Config {
2217 agents: vec![spec("a"), spec("b"), spec("c")],
2218 graph: Graph {
2219 advisors: 3,
2220 judges: 3,
2221 ..Graph::default()
2222 },
2223 ..Config::default()
2224 };
2225 let advisors = cfg.advisors().expect("advisors resolve");
2226 let judges = cfg.resolve_roles().expect("roles resolve").judges;
2227 let advisor_ids: Vec<&str> = advisors.iter().map(|a| a.id.as_str()).collect();
2228 let judge_ids: Vec<&str> = judges.iter().map(|a| a.id.as_str()).collect();
2229 assert_eq!(
2230 advisor_ids, judge_ids,
2231 "an unconfigured advisor roster must be the same seats an unconfigured judge panel gets"
2232 );
2233 }
2234
2235 #[test]
2236 fn an_unresolvable_advisor_seat_is_an_error_naming_the_id() {
2237 let cfg = Config {
2238 agents: vec![spec("a")],
2239 roles: Roles {
2240 advisors: vec!["nope".to_owned()],
2241 ..Roles::default()
2242 },
2243 graph: Graph {
2244 advisors: 1,
2245 ..Graph::default()
2246 },
2247 ..Config::default()
2248 };
2249 let err = cfg.advisors().expect_err("`nope` is not in the roster");
2250 assert!(format!("{err:#}").contains("nope"));
2251 }
2252
2253 #[test]
2254 fn repos_default_to_no_roots_and_a_day_of_trust() {
2255 assert_eq!(Config::default().repos.roots, Vec::<PathBuf>::new());
2256 assert_eq!(Config::default().repos.scan_ttl, 86_400);
2257 assert_eq!(Config::default().repos.fetch_interval, 600);
2258 }
2259
2260 #[test]
2261 fn a_config_file_with_no_repos_table_still_loads() {
2262 let dir = tempfile::tempdir().unwrap();
2263 let path = dir.path().join("magi.toml");
2264 std::fs::write(&path, "[graph]\ncandidates = 2\n").unwrap();
2265 let cfg = Config::load(&path).expect("must load without [repos]");
2266 assert_eq!(cfg.repos.roots, Vec::<PathBuf>::new());
2267 assert_eq!(cfg.repos.scan_ttl, 86_400);
2268 }
2269
2270 /// A fixture is the whole config under test.
2271 ///
2272 /// `layers` used to reach for `dirs::config_dir()` unconditionally, so on
2273 /// a machine where somebody had written `<config_dir>/magi/config.toml`
2274 /// the suite silently loaded it as the lowest layer. Adding `[repos]
2275 /// roots` there turned two web tests red - their fixtures declare
2276 /// `[repos] roots` too, and `refuse_split_arrays` rightly refuses one
2277 /// array key spread across two layers. CI stayed green throughout,
2278 /// because a runner has no such file: the suite failed only where magi is
2279 /// actually used.
2280 ///
2281 /// So a test build has no machine layer unless it asks for one, and this
2282 /// is that promise. Written against a real file at the real location so
2283 /// it fails if `machine_layer` starts reading it again.
2284 #[test]
2285 fn a_test_build_does_not_read_the_operators_machine_config() {
2286 let repo = tempfile::tempdir().unwrap();
2287 std::fs::write(repo.path().join("magi.toml"), "[graph]\ncandidates = 2\n").unwrap();
2288
2289 let layers = Config::layers(repo.path());
2290 assert_eq!(
2291 layers,
2292 vec![repo.path().join("magi.toml")],
2293 "only the fixture's own file may be a layer"
2294 );
2295 if let Some(real) = dirs::config_dir() {
2296 let machine = real.join("magi").join("config.toml");
2297 assert!(
2298 !layers.contains(&machine),
2299 "the operator's {} must not be a layer in a test build",
2300 machine.display()
2301 );
2302 }
2303 }
2304
2305 #[test]
2306 fn starter_toml_loads_through_teravars() {
2307 let dir = tempfile::tempdir().unwrap();
2308 let path = dir.path().join("magi.toml");
2309 std::fs::write(&path, Config::starter_toml()).unwrap();
2310 let parsed = Config::load(&path).expect("starter config must load");
2311 assert_eq!(parsed.graph.candidates, 3);
2312 assert_eq!(parsed.merge.mode, MergeMode::None);
2313 assert_eq!(parsed.merge.style, MergeStyle::Merge);
2314 assert!(parsed.graph.sessions);
2315 assert_eq!(parsed.graph.timeout_review, 1200);
2316 assert_eq!(parsed.graph.verify_timeout(), 1200);
2317 assert_eq!(parsed.update.mode, UpdateMode::Notify);
2318 }
2319
2320 #[test]
2321 fn pre_gate_defaults_to_empty_and_the_starter_documents_it() {
2322 let dir = tempfile::tempdir().unwrap();
2323 let path = dir.path().join("magi.toml");
2324 std::fs::write(&path, Config::starter_toml()).unwrap();
2325 assert!(Config::load(&path).unwrap().verify.pre_gate.is_empty());
2326 assert!(Config::starter_toml().contains("# pre_gate = []"));
2327 }
2328
2329 #[test]
2330 fn starter_toml_explains_inherited_and_explicit_verify_timeouts() {
2331 let starter = Config::starter_toml();
2332 assert!(starter.contains("When timeout_verify is omitted, E2E and"));
2333 assert!(starter.contains("verification independent if timeout_review changes later"));
2334 assert!(starter.contains("# timeout_verify = 1200"));
2335 }
2336
2337 /// A repository whose ruleset forbids merge commits declares that once,
2338 /// here, rather than magi asking GitHub about it on every render (see
2339 /// [`MergeStyle`]'s own doc for why).
2340 #[test]
2341 fn a_repository_can_declare_a_linear_history_merge_style() {
2342 let dir = tempfile::tempdir().unwrap();
2343 let path = dir.path().join("magi.toml");
2344 std::fs::write(&path, "[merge]\nmode = \"none\"\nstyle = \"squash\"\n").unwrap();
2345 let parsed = Config::load(&path).expect("config must load");
2346 assert_eq!(parsed.merge.style, MergeStyle::Squash);
2347 }
2348
2349 #[test]
2350 fn later_layers_win_and_vars_render() {
2351 let dir = tempfile::tempdir().unwrap();
2352 let machine = dir.path().join("machine.toml");
2353 let project = dir.path().join("magi.toml");
2354 // The machine layer owns the roster...
2355 std::fs::write(
2356 &machine,
2357 "[[agents]]\nid = \"opus\"\nkind = \"claude\"\nmodel = \"opus\"\n\n\
2358 [graph]\ncandidates = 3\nmax_parallel = 8\n",
2359 )
2360 .unwrap();
2361 // ...and the project layer only states what is repo-specific, plus a
2362 // `[vars]` value interpolated into a command.
2363 std::fs::write(
2364 &project,
2365 "[vars]\ncache = \"/shared\"\n\n\
2366 [graph]\ncandidates = 2\n\n\
2367 [verify]\ngate = [\"CARGO_TARGET_DIR={{ vars.cache }}/t cargo test\"]\n",
2368 )
2369 .unwrap();
2370
2371 let cfg = Config::load_layers(&[machine, project]).expect("layered load");
2372 assert_eq!(cfg.agents.len(), 1, "roster comes from the machine layer");
2373 assert_eq!(cfg.graph.candidates, 2, "project layer wins");
2374 assert_eq!(cfg.graph.max_parallel, 8, "machine layer survives");
2375 assert_eq!(
2376 cfg.verify.gate,
2377 ["CARGO_TARGET_DIR=/shared/t cargo test".to_owned()]
2378 );
2379 // The rendered command is where the cache path is read back from.
2380 assert_eq!(cfg.cache_dir(), Some(PathBuf::from("/shared/t")));
2381 }
2382
2383 #[test]
2384 fn talk_defaults_to_an_hour_and_an_unwritten_config_still_gets_it() {
2385 // An operator who writes no `[graph]` timeout keys at all must still
2386 // land on the hour, not on the five/fifteen minutes this turn used
2387 // to hardcode before it read from config.
2388 let g = Graph::default();
2389 assert_eq!(g.timeout_talk, 3600);
2390
2391 let dir = tempfile::tempdir().unwrap();
2392 let path = dir.path().join("magi.toml");
2393 std::fs::write(&path, "[graph]\ncandidates = 2\n").unwrap();
2394 let cfg = Config::load(&path).expect("must load without timeout_talk set");
2395 assert_eq!(cfg.graph.timeout_talk, 3600);
2396 }
2397
2398 #[test]
2399 fn an_overridden_talk_timeout_reaches_the_loaded_config() {
2400 let dir = tempfile::tempdir().unwrap();
2401 let path = dir.path().join("magi.toml");
2402 std::fs::write(&path, "[graph]\ntimeout_talk = 120\n").unwrap();
2403 let cfg = Config::load(&path).expect("must load");
2404 assert_eq!(cfg.graph.timeout_talk, 120);
2405 }
2406
2407 #[test]
2408 fn the_disk_defaults_are_the_measurements_made_up_front() {
2409 let cfg = Config::default();
2410 assert_eq!(cfg.disk.min_free_bytes, 8 * 1024 * 1024 * 1024);
2411 assert!(cfg.disk.auto_fold);
2412 assert_eq!(cfg.disk.fold_grace_secs, 6 * 60 * 60);
2413 assert_eq!(cfg.disk.cache_limit_bytes, 10 * 1024 * 1024 * 1024);
2414 }
2415
2416 #[test]
2417 fn an_unset_disk_section_is_the_safe_default() {
2418 let dir = tempfile::tempdir().unwrap();
2419 std::fs::write(dir.path().join("magi.toml"), "[graph]\ncandidates = 1\n").unwrap();
2420 let cfg = Config::load(&dir.path().join("magi.toml")).expect("load");
2421 assert_eq!(cfg.disk, Disk::default());
2422 }
2423
2424 #[test]
2425 fn env_is_available_to_templates_with_a_default() {
2426 let dir = tempfile::tempdir().unwrap();
2427 let path = dir.path().join("magi.toml");
2428 // teravars ships no `env`; magi adds it, and the `default` filter has
2429 // to cover the unset case or every machine would need the variable.
2430 //
2431 // Deliberately no named variable: `env` is keyed by the exact spelling
2432 // the OS reports, and Windows says `Path` where POSIX says `PATH`, so a
2433 // test asserting `env.PATH` passes on one runner and fails on another.
2434 // The map's non-emptiness is the platform-neutral claim.
2435 std::fs::write(
2436 &path,
2437 "[verify]\n\
2438 gate = [\"cache={{ env.MAGI_TEST_UNSET_XYZ | default(value='fallback') }}\", \
2439 \"populated={{ env | length > 0 }}\"]\n",
2440 )
2441 .unwrap();
2442 let cfg = Config::load(&path).expect("env lookup must render");
2443 assert_eq!(cfg.verify.gate[0], "cache=fallback");
2444 assert_eq!(cfg.verify.gate[1], "populated=true");
2445 }
2446
2447 #[test]
2448 fn a_broken_template_names_the_file() {
2449 let dir = tempfile::tempdir().unwrap();
2450 let path = dir.path().join("magi.toml");
2451 std::fs::write(&path, "[graph]\nlanguage = \"{{ nope.\"\n").unwrap();
2452 let err = Config::load(&path).expect_err("must not silently ignore");
2453 assert!(err.to_string().contains("teravars"), "{err}");
2454 }
2455
2456 #[test]
2457 fn tera_syntax_in_comments_is_inert() {
2458 // teravars >= 0.2.2 strips `#` comments before Tera sees the file, so a
2459 // comment may quote template syntax without rendering. Before 0.2.2 this
2460 // load failed: the commented-out braces reached the template parser.
2461 let dir = tempfile::tempdir().unwrap();
2462 let path = dir.path().join("magi.toml");
2463 std::fs::write(
2464 &path,
2465 "# a comment may quote templates: `{{ env.NOPE | default(value='x') }}` and `{% if %}`\n\
2466 [graph]\ncandidates = 2\n",
2467 )
2468 .unwrap();
2469 let cfg = Config::load(&path).expect("comments must be inert, not rendered");
2470 assert_eq!(cfg.graph.candidates, 2);
2471 }
2472
2473 #[test]
2474 fn opencode_defaults_to_file_delivery() {
2475 let mut s = spec("oc");
2476 s.kind = AgentKind::Opencode;
2477 assert_eq!(s.delivery(), Delivery::File);
2478 s.prompt_delivery = Some(Delivery::Argv);
2479 assert_eq!(s.delivery(), Delivery::Argv);
2480 }
2481 #[test]
2482 fn the_land_loop_is_on_but_it_cannot_merge_without_being_asked() {
2483 // Both default on, and that pair is the safety property: `land` takes
2484 // over the watching an operator was doing by hand, `land_approval`
2485 // keeps the irreversible step a human decision. An unattended merge
2486 // needs BOTH flipped, which has to be chosen deliberately twice.
2487 let g = Graph::default();
2488 assert!(
2489 g.land,
2490 "stopping at an open PR left the watching to a human"
2491 );
2492 assert!(
2493 g.land_approval,
2494 "on-by-default land is only defensible while this is also on"
2495 );
2496 assert!(g.land_rounds > 0, "a loop with no budget never terminates");
2497 assert!(
2498 g.hold_contested_merge,
2499 "a contested hand-off must still reach a human when approvals are off"
2500 );
2501 }
2502 #[test]
2503 fn an_array_declared_in_two_layers_is_refused_instead_of_concatenated() {
2504 // teravars appends arrays. For an ordered list of seats, or an argv,
2505 // the concatenation is something neither file says - and the operator
2506 // pays for the extra seats by the token.
2507 let dir = tempfile::tempdir().unwrap();
2508 let machine = dir.path().join("machine.toml");
2509 let repo = dir.path().join("magi.toml");
2510 std::fs::write(&machine, "[roles]\nimplementers = [\"a\", \"b\"]\n").unwrap();
2511 std::fs::write(&repo, "[roles]\nimplementers = [\"oc\"]\n").unwrap();
2512
2513 let err = Config::load_layers(&[machine.clone(), repo.clone()])
2514 .expect_err("two layers naming one array must not merge silently")
2515 .to_string();
2516 assert!(err.contains("roles.implementers"), "{err}");
2517 // Both files are named: the fix is to delete one of them, and the
2518 // operator has to know which two to choose between.
2519 assert!(err.contains("machine.toml"), "{err}");
2520 assert!(err.contains("magi.toml"), "{err}");
2521 }
2522
2523 #[test]
2524 fn a_scalar_in_one_layer_and_an_array_in_another_still_merges() {
2525 // The split the layering exists for: state a preference machine-wide,
2526 // let the repository own its own lists.
2527 let dir = tempfile::tempdir().unwrap();
2528 let machine = dir.path().join("machine.toml");
2529 let repo = dir.path().join("magi.toml");
2530 std::fs::write(&machine, "[roles]\nchatter = \"opus\"\n").unwrap();
2531 std::fs::write(
2532 &repo,
2533 "[[agents]]\nid = \"oc\"\nkind = \"opencode\"\n\n\
2534 [roles]\nimplementers = [\"oc\"]\n",
2535 )
2536 .unwrap();
2537
2538 let cfg = Config::load_layers(&[machine, repo]).expect("layers merge");
2539 assert_eq!(primary(cfg.roles.chatter.as_ref()), Some("opus"));
2540 assert_eq!(cfg.roles.implementers, ["oc"]);
2541 assert_eq!(cfg.agents.len(), 1, "the roster is not doubled");
2542 }
2543
2544 #[test]
2545 fn two_layers_declaring_verify_gate_run_both_in_priority_order() {
2546 // The `editorconfig-checker` distribution problem: a shared layer
2547 // wants to add a gate command without erasing the repository's own.
2548 let dir = tempfile::tempdir().unwrap();
2549 let machine = dir.path().join("machine.toml");
2550 let repo = dir.path().join("magi.toml");
2551 std::fs::write(&machine, "[verify]\ngate = [\"editorconfig-checker\"]\n").unwrap();
2552 std::fs::write(&repo, "[verify]\ngate = [\"cargo make check\"]\n").unwrap();
2553
2554 let cfg = Config::load_layers(&[machine, repo]).expect("appendable arrays must merge");
2555 assert_eq!(
2556 cfg.verify.gate,
2557 [
2558 "editorconfig-checker".to_owned(),
2559 "cargo make check".to_owned()
2560 ],
2561 "low-priority (machine) command first, high-priority (repo) command after"
2562 );
2563 }
2564
2565 #[test]
2566 fn two_layers_declaring_verify_e2e_run_both_in_priority_order() {
2567 let dir = tempfile::tempdir().unwrap();
2568 let machine = dir.path().join("machine.toml");
2569 let repo = dir.path().join("magi.toml");
2570 std::fs::write(&machine, "[verify]\ne2e = [\"shared-smoke-test\"]\n").unwrap();
2571 std::fs::write(&repo, "[verify]\ne2e = [\"cargo test\"]\n").unwrap();
2572
2573 let cfg = Config::load_layers(&[machine, repo]).expect("appendable arrays must merge");
2574 assert_eq!(
2575 cfg.verify.e2e,
2576 ["shared-smoke-test".to_owned(), "cargo test".to_owned()]
2577 );
2578 }
2579
2580 #[test]
2581 fn two_layers_declaring_repos_roots_are_both_scanned() {
2582 let dir = tempfile::tempdir().unwrap();
2583 let machine = dir.path().join("machine.toml");
2584 let repo = dir.path().join("magi.toml");
2585 std::fs::write(&machine, "[repos]\nroots = [\"/machine/root\"]\n").unwrap();
2586 std::fs::write(&repo, "[repos]\nroots = [\"/repo/root\"]\n").unwrap();
2587
2588 let cfg = Config::load_layers(&[machine, repo]).expect("appendable arrays must merge");
2589 assert_eq!(
2590 cfg.repos.roots,
2591 [PathBuf::from("/machine/root"), PathBuf::from("/repo/root")]
2592 );
2593 }
2594
2595 #[test]
2596 fn duplicate_gate_commands_across_layers_both_run() {
2597 // Dropping the duplicate would be a silent surprise; the operator
2598 // sees a slower gate, never a missing one.
2599 let dir = tempfile::tempdir().unwrap();
2600 let machine = dir.path().join("machine.toml");
2601 let repo = dir.path().join("magi.toml");
2602 std::fs::write(&machine, "[verify]\ngate = [\"same-command\"]\n").unwrap();
2603 std::fs::write(&repo, "[verify]\ngate = [\"same-command\"]\n").unwrap();
2604
2605 let cfg = Config::load_layers(&[machine, repo]).expect("appendable arrays must merge");
2606 assert_eq!(
2607 cfg.verify.gate,
2608 ["same-command".to_owned(), "same-command".to_owned()]
2609 );
2610 }
2611
2612 #[test]
2613 fn notify_command_is_still_refused_across_two_layers() {
2614 // An argv, not a set: concatenating two of them is not a program.
2615 let dir = tempfile::tempdir().unwrap();
2616 let machine = dir.path().join("machine.toml");
2617 let repo = dir.path().join("magi.toml");
2618 std::fs::write(&machine, "[notify]\ncommand = [\"ntfy\", \"publish\"]\n").unwrap();
2619 std::fs::write(&repo, "[notify]\ncommand = [\"curl\", \"-X\"]\n").unwrap();
2620
2621 let err = Config::load_layers(&[machine.clone(), repo.clone()])
2622 .expect_err("an argv split across layers must not concatenate")
2623 .to_string();
2624 assert!(err.contains("notify.command"), "{err}");
2625 assert!(err.contains("machine.toml"), "{err}");
2626 assert!(err.contains("magi.toml"), "{err}");
2627 }
2628
2629 #[test]
2630 fn one_layer_declaring_verify_gate_runs_unchanged() {
2631 // The classification must not change behaviour for the configuration
2632 // this very repository has today: exactly one layer names the gate.
2633 let dir = tempfile::tempdir().unwrap();
2634 let path = dir.path().join("magi.toml");
2635 std::fs::write(&path, "[verify]\ngate = [\"cargo make check\"]\n").unwrap();
2636
2637 let cfg = Config::load(&path).expect("single layer must still load");
2638 assert_eq!(cfg.verify.gate, ["cargo make check".to_owned()]);
2639 }
2640
2641 #[test]
2642 fn describe_composed_names_the_contributing_layers_only_when_there_are_two() {
2643 let dir = tempfile::tempdir().unwrap();
2644 let machine = dir.path().join("machine.toml");
2645 let repo = dir.path().join("magi.toml");
2646 std::fs::write(&machine, "[verify]\ngate = [\"editorconfig-checker\"]\n").unwrap();
2647 std::fs::write(&repo, "[verify]\ngate = [\"cargo make check\"]\n").unwrap();
2648 let paths = vec![machine.clone(), repo.clone()];
2649
2650 let cfg = Config::load_layers(&paths).expect("appendable arrays must merge");
2651 let described =
2652 Config::describe_composed(&paths, &cfg.verify.gate, "verify.gate", "(none)");
2653 assert!(described.contains("editorconfig-checker && cargo make check"));
2654 assert!(
2655 described.contains(&machine.display().to_string()),
2656 "{described}"
2657 );
2658 assert!(
2659 described.contains(&repo.display().to_string()),
2660 "{described}"
2661 );
2662
2663 // A single contributing layer stays the plain one-line summary.
2664 let single = vec![repo.clone()];
2665 let solo_cfg = Config::load_layers(&single).expect("single layer loads");
2666 let solo_described =
2667 Config::describe_composed(&single, &solo_cfg.verify.gate, "verify.gate", "(none)");
2668 assert_eq!(solo_described, "cargo make check");
2669 }
2670}