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}
959
960impl Default for Daemon {
961 fn default() -> Self {
962 Self {
963 max_concurrent_runs: 1,
964 pause_for_interrupts: false,
965 max_deputies: 2,
966 }
967 }
968}
969
970/// Where `magi repos` and `GET /api/repos` look for local checkouts.
971///
972/// `roots` is one of the array keys [`array_merge_policy`] marks as
973/// append-across-layers: which checkouts exist in general is a *machine*
974/// fact in the same way the agent roster is - a repository's own `magi.toml`
975/// cannot state where its siblings live before magi has resolved which
976/// repository to read that file from in the first place - but a repository
977/// that genuinely has an extra root worth scanning is not forced to choose
978/// between an error and losing the machine's roots outright. Both layers'
979/// roots are scanned; see [`Config::refuse_split_arrays`] for the keys that
980/// are still refused.
981#[derive(Debug, Clone, Deserialize, Serialize)]
982#[serde(deny_unknown_fields, default)]
983pub struct Repos {
984 /// Roots to scan for a ghq-layout checkout: `<root>/<host>/<owner>/<repo>`
985 /// with a `.git` directory. Empty by default - nothing is scanned unless
986 /// asked to be.
987 pub roots: Vec<PathBuf>,
988 /// How long a scan is trusted before the next request re-scans it,
989 /// seconds. `0` means never trust it: scan on every request. Defaults to
990 /// a day, the same order of magnitude as [`Graph::answer_timeout`] for
991 /// the same reason - a checkout does not usually appear or vanish inside
992 /// a session, so there is little to gain from scanning more often than
993 /// that, and an explicit refresh exists for the moment one does.
994 pub scan_ttl: u64,
995 /// How often `magi serve` runs `git fetch origin` in every checkout under
996 /// `roots`, seconds, so `origin/main` stays fresh whatever state the
997 /// working tree is in. Fetch only: no branch, HEAD or working tree is
998 /// touched. `0` disables it.
999 pub fetch_interval: u64,
1000}
1001
1002impl Default for Repos {
1003 fn default() -> Self {
1004 Self {
1005 roots: Vec::new(),
1006 scan_ttl: 86_400,
1007 fetch_interval: 600,
1008 }
1009 }
1010}
1011
1012/// Project-specific text appended to each node's prompt.
1013///
1014/// **Additive by construction.** These fields cannot replace magi's prompts,
1015/// only extend them, and that restriction is the whole design. The built-in
1016/// prompts carry the invariants the competition rests on: a judging prompt
1017/// names no authors, every structured answer must arrive as one fenced `json`
1018/// block, and a judge is told not to speculate about who wrote what. A config
1019/// that could overwrite them would let a typo silently un-blind the panel or
1020/// break the parser, and the symptom would be "the judges got worse" rather
1021/// than an error.
1022///
1023/// Repository-wide context belongs in `AGENTS.md`, which every agent already
1024/// reads from the checkout. Use these fields for the things a *magi node*
1025/// needs to know and a repository file cannot say - for instance that
1026/// reviewers here should ignore formatting because a hook owns it.
1027#[derive(Debug, Clone, Default, Deserialize, Serialize)]
1028#[serde(deny_unknown_fields, default)]
1029pub struct Prompts {
1030 /// Appended to every node's prompt.
1031 pub all: String,
1032 /// Appended for implementers.
1033 pub implement: String,
1034 /// Appended for judges, both ranking and voting.
1035 pub judge: String,
1036 /// Appended for reviewers.
1037 pub review: String,
1038 /// Appended for the fixer.
1039 pub fix: String,
1040}
1041
1042impl Prompts {
1043 /// The overlay for one node, or `None` when nothing is configured.
1044 ///
1045 /// `node` is the graph's own node name, so a new node gets no overlay
1046 /// rather than the wrong one.
1047 pub fn overlay(&self, node: &str) -> Option<String> {
1048 let specific = match node {
1049 "implement" => &self.implement,
1050 "judge" | "vote" | "deliberate" => &self.judge,
1051 "review" => &self.review,
1052 "fix" => &self.fix,
1053 _ => "",
1054 };
1055 let mut parts: Vec<&str> = Vec::new();
1056 for p in [self.all.trim(), specific.trim()] {
1057 if !p.is_empty() {
1058 parts.push(p);
1059 }
1060 }
1061 if parts.is_empty() {
1062 return None;
1063 }
1064 Some(parts.join("\n\n"))
1065 }
1066}
1067
1068/// How the operator is told that a run is waiting on them.
1069///
1070/// A command rather than a built-in integration: magi is one binary with no
1071/// network dependencies, and every operator's notification path is different -
1072/// ntfy, a Slack webhook, a Windows toast, an SSH to a machine that beeps.
1073/// Shelling out keeps all of them possible and none of them magi's problem.
1074#[derive(Debug, Clone, Default, Deserialize, Serialize)]
1075#[serde(deny_unknown_fields, default)]
1076pub struct Notify {
1077 /// Command and arguments. `{summary}`, `{run}` and `{url}` are replaced.
1078 /// Empty means no notification - the web UI is then the only surface.
1079 pub command: Vec<String>,
1080}
1081
1082/// Policy for [`crate::talk`], the standing conversation.
1083#[derive(Debug, Clone, Default, Deserialize, Serialize)]
1084#[serde(deny_unknown_fields, default)]
1085pub struct Talk {
1086 /// Let the conversation's agent edit files in the repository instead of
1087 /// filing a task for one. **Off by default** - see
1088 /// [`crate::talk`]'s module doc for why an edit made mid-conversation is
1089 /// an edit no run and no review can be attributed to, which is exactly
1090 /// the property a repository entered in a competition depends on. A
1091 /// repository that is never judged - dotfiles, a personal config
1092 /// checkout - has nothing to lose by turning this on in its own
1093 /// `magi.toml`, and a one-line fix stops costing a queued task to get.
1094 pub allow_write: bool,
1095}
1096
1097/// Roles resolved to concrete agent specs for one run.
1098#[derive(Debug, Clone)]
1099pub struct ResolvedRoles {
1100 /// One per candidate.
1101 pub implementers: Vec<AgentSpec>,
1102 /// One per judge.
1103 pub judges: Vec<AgentSpec>,
1104 /// One per reviewer slot.
1105 pub reviewers: Vec<AgentSpec>,
1106 /// Explicit fixer, if configured.
1107 pub fixer: Option<AgentSpec>,
1108 /// Queue conductor, explicitly selected or resolved by the standalone-seat fallback.
1109 pub conductor: AgentSpec,
1110 /// The full ordered implementer roster, in [`Roles::implementers`]'s own
1111 /// order — or `[[agents]]` in file order, when that list is empty. Unlike
1112 /// [`Self::implementers`], never truncated to `graph.candidates` and
1113 /// never `rotate`d/wrapped: a solo run (`candidates = 1`) resolves
1114 /// `implementers` down to a single slot, but `graph::Runner`'s per-seat
1115 /// quota fallback needs the *whole* list to walk forward through when
1116 /// that one slot's agent runs out of quota mid-run.
1117 pub implementer_roster: Vec<AgentSpec>,
1118 /// [`Self::implementer_roster`]'s counterpart for judge seats: the whole
1119 /// `[roles] judges` list (or every agent), untruncated and unrotated, for
1120 /// the per-seat handover when a judge's agent fails.
1121 pub judge_roster: Vec<AgentSpec>,
1122 /// Likewise for reviewer seats.
1123 pub reviewer_roster: Vec<AgentSpec>,
1124}
1125
1126/// Every array-valued key in a config table, as a dotted path.
1127///
1128/// Dotted so the error names `roles.implementers` rather than `implementers`:
1129/// an operator with three config files needs to know which key, not just that
1130/// there was one. `vars` is skipped because it is teravars' own input, merged
1131/// on purpose and never deserialised into `Config`.
1132fn array_keys(table: &toml::value::Table, prefix: &str) -> Vec<String> {
1133 let mut out = Vec::new();
1134 for (k, v) in table {
1135 if prefix.is_empty() && k == "vars" {
1136 continue;
1137 }
1138 let path = if prefix.is_empty() {
1139 k.clone()
1140 } else {
1141 format!("{prefix}.{k}")
1142 };
1143 match v {
1144 toml::Value::Array(_) => out.push(path),
1145 toml::Value::Table(t) => out.extend(array_keys(t, &path)),
1146 _ => {}
1147 }
1148 }
1149 out
1150}
1151
1152/// How an array key behaves when two config layers both declare it.
1153#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1154enum ArrayMerge {
1155 /// Two layers may both declare it; the composed value is the
1156 /// low-to-high-priority concatenation teravars already produces (see
1157 /// [`Config::load_layers`]'s doc for why that order and no dedup).
1158 Append,
1159 /// Two layers declaring it is refused; see
1160 /// [`Config::refuse_split_arrays`].
1161 Replace,
1162}
1163
1164/// The single place that decides, for a dotted array key (as returned by
1165/// [`array_keys`]), whether declaring it in two config layers is a
1166/// concatenation the operator asked for or a silent accident.
1167///
1168/// Kept as one match so the whole policy is visible in one place - the same
1169/// reason `claude_quota` and `dropped_stream` close their own classification
1170/// in one spot elsewhere in this codebase. Anything not listed defaults to
1171/// [`ArrayMerge::Replace`]: refusing is the safe default for a key nobody has
1172/// reasoned about yet, and a new array key added later has to be added here
1173/// deliberately to become appendable.
1174///
1175/// - `verify.e2e` / `verify.gate` — a "run all of these, all must exit 0"
1176/// gate. Concatenating two of them is exactly the checks both layers
1177/// wanted, which is what lets a common gate (e.g. `editorconfig-checker`)
1178/// live in a shared layer while a repository's own layer adds its own
1179/// command, instead of every repository copying the shared command into
1180/// its own file.
1181/// - `repos.roots` — a set of directories to scan for checkouts. A
1182/// repository adding its own root on top of the machine's is additive by
1183/// nature, not a replacement of where the machine looks; see
1184/// [`Repos::roots`].
1185///
1186/// Left on the refuse side, and why:
1187/// - `roles.implementers` / `roles.judges` / `roles.reviewers` — an ordered
1188/// list of *seats*, not a set. A machine's two implementers plus a
1189/// repository's one is three seats nobody asked for and nobody is paying
1190/// for on purpose.
1191/// - `notify.command` — an argv. Concatenating two argvs does not produce a
1192/// program that runs; it produces `["ntfy", "publish", "curl", "-X"]`.
1193/// - `blind.strip_lines` — technically safe to concatenate (each entry is
1194/// matched as an independent substring, so a longer list only strips
1195/// *more*), but left on the refuse side anyway: the same list also drives
1196/// `commit_msg_hook`'s generated `sed` addresses, where position matters,
1197/// and a silent three-layer merge is exactly the kind of surprise
1198/// `refuse_split_arrays` exists to catch rather than to reason about
1199/// case-by-case. A repository that wants one more stripped phrase restates
1200/// the whole list; that restatement is visible in review, an accidental
1201/// concatenation would not be.
1202fn array_merge_policy(key: &str) -> ArrayMerge {
1203 match key {
1204 "verify.e2e" | "verify.gate" | "verify.pre_gate" | "repos.roots" => ArrayMerge::Append,
1205 _ => ArrayMerge::Replace,
1206 }
1207}
1208
1209impl Config {
1210 /// Load one file through teravars: Tera rendering, `[vars]` resolution,
1211 /// and the `include = [...]` directive.
1212 pub fn load(path: &Path) -> Result<Self> {
1213 Self::load_layers(&[path.to_path_buf()])
1214 }
1215
1216 /// The Tera render context shared by every layer: `system.*` (from
1217 /// teravars), `env` (magi's own addition - a config that names a shared
1218 /// build-cache directory or a machine-specific path needs
1219 /// `{{ env.NAME | default(value='...') }}`), and `repo` / `repo_name`
1220 /// derived from the last (highest-priority) path's parent directory.
1221 ///
1222 /// Factored out so [`Config::array_provenance`] can re-render a single
1223 /// layer under the exact same context [`Config::load_layers`] uses for
1224 /// the joint render, rather than drifting from it by accident.
1225 fn render_ctx(paths: &[PathBuf]) -> teravars::Context {
1226 let mut ctx = teravars::system_context();
1227 let env: std::collections::BTreeMap<String, String> = std::env::vars().collect();
1228 ctx.insert("env", &env);
1229 if let Some(last) = paths.last()
1230 && let Some(dir) = last.parent()
1231 {
1232 ctx.insert("repo", &dir.to_string_lossy());
1233 ctx.insert(
1234 "repo_name",
1235 &dir.file_name().unwrap_or_default().to_string_lossy(),
1236 );
1237 }
1238 ctx
1239 }
1240
1241 /// Load and deep-merge a stack of config files, later files winning.
1242 ///
1243 /// This is why the config is TOML-through-teravars rather than plain serde:
1244 /// the roster is a *machine* fact (which CLIs and plans you pay for) while
1245 /// the gate is a *repository* fact (`cargo make check` here, `pnpm test`
1246 /// there). Picking one file and ignoring the other would force every repo
1247 /// to restate the roster.
1248 pub fn load_layers(paths: &[PathBuf]) -> Result<Self> {
1249 let mut engine = teravars::Engine::default();
1250 let ctx = Self::render_ctx(paths);
1251 if paths.len() > 1 {
1252 Self::refuse_split_arrays(paths, &mut engine, &ctx)?;
1253 }
1254 let merged = teravars::load_merged(paths, &mut engine, &ctx).with_context(|| {
1255 format!(
1256 "rendering config via teravars: {}",
1257 paths
1258 .iter()
1259 .map(|p| p.display().to_string())
1260 .collect::<Vec<_>>()
1261 .join(", ")
1262 )
1263 })?;
1264 let mut table = merged.config;
1265 // `[vars]` is teravars' own input, already resolved into the render
1266 // context; `deny_unknown_fields` must not trip over it.
1267 table.remove("vars");
1268 // No layer says anything about `agents`: the roster is whatever is on
1269 // `PATH` now, exactly as when no layer exists at all. An explicit
1270 // `agents = []` is a statement and is kept.
1271 let detect_agents = !table.contains_key("agents");
1272 let mut cfg: Self = toml::Value::Table(table)
1273 .try_into()
1274 .context("deserializing magi config")?;
1275 if detect_agents {
1276 cfg.agents = Self::autodetected().agents;
1277 }
1278 Ok(cfg)
1279 }
1280
1281 /// Refuse an array that two layers both declare, unless
1282 /// [`array_merge_policy`] says that key is meant to accumulate.
1283 ///
1284 /// teravars **appends** arrays when it merges layers, and that is wrong for
1285 /// most arrays magi has: `implementers` is an ordered list of seats,
1286 /// `notify.command` is an argv. Concatenating two of them yields something
1287 /// nobody wrote - three implementers out of a machine's two and a
1288 /// repository's one, or an argv of `["ntfy", "publish", "curl", "-X"]`.
1289 ///
1290 /// Replacing instead would be the right merge rule for those keys, but the
1291 /// rule lives in teravars, which several other projects depend on;
1292 /// changing it there is a decision for that crate, not something to fake
1293 /// here by re-reading the files with different semantics and hoping the
1294 /// two paths agree.
1295 ///
1296 /// So magi refuses the ambiguity rather than resolving it silently, for
1297 /// every array key except the short, deliberate list
1298 /// [`array_merge_policy`] marks [`ArrayMerge::Append`] - for those, the
1299 /// concatenation teravars already produces *is* what both files say, so
1300 /// there is nothing to refuse. The cost of guessing wrong on the refused
1301 /// keys is a roster the operator did not ask for and is paying for by the
1302 /// token; the append keys carry no such risk because every element runs
1303 /// (or every directory is scanned) regardless of order.
1304 fn refuse_split_arrays(
1305 paths: &[PathBuf],
1306 engine: &mut teravars::Engine,
1307 ctx: &teravars::Context,
1308 ) -> Result<()> {
1309 let mut seen: std::collections::BTreeMap<String, PathBuf> = Default::default();
1310 for path in paths {
1311 let one = teravars::load_merged([path], engine, ctx)
1312 .with_context(|| format!("rendering {}", path.display()))?;
1313 for key in array_keys(&one.config, "") {
1314 if array_merge_policy(&key) == ArrayMerge::Append {
1315 continue;
1316 }
1317 if let Some(first) = seen.get(&key) {
1318 bail!(
1319 "`{key}` is an array declared in two config layers:\n \
1320 {}\n {}\nteravars appends arrays when it merges, so \
1321 magi would run the concatenation of both - which is \
1322 not what either file says. Declare `{key}` in exactly \
1323 one of them.",
1324 first.display(),
1325 path.display()
1326 );
1327 }
1328 seen.insert(key, path.clone());
1329 }
1330 }
1331 Ok(())
1332 }
1333
1334 /// Which layers contributed to a composed, appendable array key (e.g.
1335 /// `"verify.gate"`), in the same low-to-high-priority order
1336 /// [`Config::load_layers`] concatenates them in. Layers that do not
1337 /// declare `key` at all are omitted.
1338 ///
1339 /// This is a **display aid for `magi doctor` only.** The command list
1340 /// that actually runs always comes from the one joint
1341 /// [`teravars::load_merged`] call in `load_layers`, never from this
1342 /// function - the exact hazard [`Config::refuse_split_arrays`] warns
1343 /// about is two merge paths that might disagree, so this function must
1344 /// never become a second source of the *composed* value, only of which
1345 /// file wrote which line in it.
1346 ///
1347 /// Re-rendering each layer alone can, in principle, resolve a
1348 /// `{{ vars.x }}` differently than the joint render would, if `x` is
1349 /// defined in one layer and referenced in another - the same caveat
1350 /// `refuse_split_arrays`'s structural, key-only check already lives with.
1351 /// None of magi's own gate commands cross that line, and a doctor listing
1352 /// is read by a human who can compare it against the joint one printed
1353 /// alongside it, so this is judged worth the simplicity of not
1354 /// threading provenance through the real load path.
1355 pub fn array_provenance(paths: &[PathBuf], key: &str) -> Vec<(PathBuf, Vec<String>)> {
1356 let mut engine = teravars::Engine::default();
1357 let ctx = Self::render_ctx(paths);
1358 let mut out = Vec::new();
1359 for path in paths {
1360 let Ok(one) = teravars::load_merged([path], &mut engine, &ctx) else {
1361 continue;
1362 };
1363 let mut cur = &one.config;
1364 let mut found = None;
1365 let parts: Vec<&str> = key.split('.').collect();
1366 for (i, part) in parts.iter().enumerate() {
1367 match cur.get(*part) {
1368 Some(toml::Value::Array(a)) if i == parts.len() - 1 => {
1369 found = Some(a);
1370 break;
1371 }
1372 Some(toml::Value::Table(t)) => cur = t,
1373 _ => break,
1374 }
1375 }
1376 let Some(values) = found else { continue };
1377 let strings: Vec<String> = values
1378 .iter()
1379 .filter_map(|v| v.as_str().map(str::to_owned))
1380 .collect();
1381 if !strings.is_empty() {
1382 out.push((path.clone(), strings));
1383 }
1384 }
1385 out
1386 }
1387
1388 /// Each layer rendered on its own, with the outcome per file: the
1389 /// settings screen's way of saying which layer a value came from and which
1390 /// layer is the one that does not parse. A **display aid only**, for the
1391 /// same reason as [`Config::array_provenance`]: the effective config
1392 /// always comes from the one joint [`Config::load_layers`].
1393 pub(crate) fn layer_tables(paths: &[PathBuf]) -> Vec<(PathBuf, Result<toml::Table>)> {
1394 let mut engine = teravars::Engine::default();
1395 let ctx = Self::render_ctx(paths);
1396 paths
1397 .iter()
1398 .map(|path| {
1399 let one = teravars::load_merged([path], &mut engine, &ctx)
1400 .map(|m| m.config)
1401 .with_context(|| format!("rendering {}", path.display()));
1402 (path.clone(), one)
1403 })
1404 .collect()
1405 }
1406
1407 /// Render a composed command list for `magi doctor`: the joined command
1408 /// line the run actually uses, plus - only when more than one layer
1409 /// contributed - which layer wrote which line.
1410 ///
1411 /// A single contributing layer (the common case today) stays the plain
1412 /// one-line summary magi has always printed, `empty` included: that
1413 /// honest "(none — ...)" is what caught a real gate-composition gap
1414 /// before this array could compose at all, and composition should not
1415 /// make the common case noisier.
1416 pub fn describe_composed(
1417 paths: &[PathBuf],
1418 commands: &[String],
1419 key: &str,
1420 empty: &str,
1421 ) -> String {
1422 if commands.is_empty() {
1423 return empty.to_owned();
1424 }
1425 let joined = commands.join(" && ");
1426 let provenance = Self::array_provenance(paths, key);
1427 if provenance.len() <= 1 {
1428 return joined;
1429 }
1430 let mut out = joined;
1431 for (path, cmds) in &provenance {
1432 out.push_str(&format!("\n [{}] {}", path.display(), cmds.join(" && ")));
1433 }
1434 out
1435 }
1436
1437 /// Resolve the config for `repo`, honouring an explicit `--config` path.
1438 ///
1439 /// Returns the config and the layers it came from, empty for built-in
1440 /// defaults.
1441 pub fn discover(repo: &Path, explicit: Option<&Path>) -> Result<(Self, Vec<PathBuf>)> {
1442 if let Some(p) = explicit {
1443 let paths = vec![p.to_path_buf()];
1444 return Ok((Self::load_layers(&paths)?, paths));
1445 }
1446 let paths = Self::layers(repo);
1447 if paths.is_empty() {
1448 return Ok((Self::autodetected(), paths));
1449 }
1450 Ok((Self::load_layers(&paths)?, paths))
1451 }
1452 /// Environment variable that relocates the machine-wide config layer.
1453 ///
1454 /// Set it to a directory and magi reads `<dir>/magi/config.toml` instead
1455 /// of the one under [`dirs::config_dir`]; set it to the empty string and
1456 /// magi reads no machine layer at all.
1457 ///
1458 /// This exists because the machine layer is otherwise unavoidable, and a
1459 /// test that builds a config fixture is not asking for the operator's
1460 /// preferences to be merged into it. Adding `[repos] roots` to the real
1461 /// machine config on a development box turned two passing tests red -
1462 /// `repos_list_returns_name_and_path_for_every_configured_root` and
1463 /// `repos_list_only_rescans_within_the_ttl_when_asked_to`, whose fixtures
1464 /// declare `[repos] roots` of their own, which [`Config::layers`] then
1465 /// found in two layers and [`Config::refuse_split_arrays`] correctly
1466 /// refused. CI never saw it: a runner has no machine config, so the suite
1467 /// was green there and red only where somebody actually uses magi.
1468 ///
1469 /// An operator gets the same escape hatch for free: a second machine
1470 /// config, or none, without moving files about.
1471 pub const CONFIG_DIR_ENV: &str = "MAGI_CONFIG_DIR";
1472
1473 /// Every config layer that applies to `repo`, in increasing precedence.
1474 ///
1475 /// The machine layer is whatever [`Config::machine_layer`] resolves to,
1476 /// which is nothing at all in a test build.
1477 pub fn layers(repo: &Path) -> Vec<PathBuf> {
1478 let mut paths = Vec::new();
1479 paths.extend(Self::machine_layer());
1480 paths.push(repo.join(".magi").join("config.toml"));
1481 paths.push(repo.join("magi.toml"));
1482 paths.retain(|p| p.is_file());
1483 paths
1484 }
1485
1486 /// The machine-wide layer's path, when there is one.
1487 ///
1488 /// **A test build has none unless it names one.** A fixture is a complete
1489 /// statement of the config under test, and the operator's own preferences
1490 /// have no business being merged into it - least of all silently, on one
1491 /// machine, in a suite that is green everywhere else.
1492 #[cfg(test)]
1493 pub(crate) fn machine_layer() -> Option<PathBuf> {
1494 std::env::var(Self::CONFIG_DIR_ENV)
1495 .ok()
1496 .filter(|dir| !dir.trim().is_empty())
1497 .map(|dir| PathBuf::from(dir).join("magi").join("config.toml"))
1498 }
1499
1500 /// The machine-wide layer's path, when there is one.
1501 #[cfg(not(test))]
1502 pub(crate) fn machine_layer() -> Option<PathBuf> {
1503 match std::env::var(Self::CONFIG_DIR_ENV) {
1504 // Named, and empty on purpose: no machine layer.
1505 Ok(dir) if dir.trim().is_empty() => None,
1506 Ok(dir) => Some(PathBuf::from(dir).join("magi").join("config.toml")),
1507 Err(_) => dirs::config_dir().map(|dir| dir.join("magi").join("config.toml")),
1508 }
1509 }
1510
1511 /// Built-in config whose roster is the agent CLIs found on `PATH`.
1512 pub fn autodetected() -> Self {
1513 let mut cfg = Self::default();
1514 for (kind, id, model) in [
1515 (AgentKind::Claude, "opus", Some("opus")),
1516 (AgentKind::Claude, "sonnet", Some("sonnet")),
1517 (AgentKind::Antigravity, "antigravity", None),
1518 (AgentKind::Opencode, "opencode", None),
1519 (AgentKind::Codex, "codex", None),
1520 (AgentKind::Omp, "omp", None),
1521 ] {
1522 if kind.program().is_some_and(which) && !cfg.agents.iter().any(|a| a.id == id) {
1523 cfg.agents.push(AgentSpec {
1524 id: id.to_owned(),
1525 kind,
1526 model: model.map(str::to_owned),
1527 command: Vec::new(),
1528 extra_args: Vec::new(),
1529 env: BTreeMap::new(),
1530 prompt_delivery: None,
1531 });
1532 }
1533 }
1534 cfg
1535 }
1536
1537 /// The shared build cache the verify commands and the agents both build
1538 /// into, when the config declares one. See [`Verify::cache_dir`].
1539 pub fn cache_dir(&self) -> Option<PathBuf> {
1540 self.verify.cache_dir()
1541 }
1542
1543 /// Look an agent up by id.
1544 pub fn agent(&self, id: &str) -> Result<&AgentSpec> {
1545 self.agents
1546 .iter()
1547 .find(|a| a.id == id)
1548 .with_context(|| format!("no agent with id `{id}` in the roster"))
1549 }
1550
1551 /// Rotate `count` seats out of `ids`, or out of the whole roster at
1552 /// `offset` when `ids` is empty.
1553 ///
1554 /// The one rotation rule - explicit ids cycle, an empty list rotates the
1555 /// roster - shared by every seat count [`Config::resolve_roles`] fills in,
1556 /// rather than each seat reimplementing it and drifting apart.
1557 fn rotate(&self, ids: &[String], count: usize, offset: usize) -> Result<Vec<AgentSpec>> {
1558 let mut out = Vec::with_capacity(count);
1559 for i in 0..count {
1560 let spec = if ids.is_empty() {
1561 self.agents[(i + offset) % self.agents.len()].clone()
1562 } else {
1563 self.agent(&ids[i % ids.len()])?.clone()
1564 };
1565 out.push(spec);
1566 }
1567 Ok(out)
1568 }
1569
1570 /// `ids`, resolved to specs in the order named, or the whole `[[agents]]`
1571 /// roster in file order when `ids` is empty — the same "explicit ids
1572 /// stand alone, an empty list means the whole roster" rule [`Self::rotate`]
1573 /// applies, but with no `count` to truncate to and no `offset` to wrap by.
1574 /// See [`ResolvedRoles::implementer_roster`] for why a truncated, rotated
1575 /// list cannot answer the question this exists for.
1576 fn full_roster(&self, ids: &[String]) -> Result<Vec<AgentSpec>> {
1577 if ids.is_empty() {
1578 Ok(self.agents.clone())
1579 } else {
1580 ids.iter().map(|id| self.agent(id).cloned()).collect()
1581 }
1582 }
1583
1584 /// Fill the roles out to the configured widths.
1585 ///
1586 /// An empty role list rotates through the whole roster, so a three-agent
1587 /// roster with `candidates = 3` gives one implementation per agent, and
1588 /// `judges = 3` rotates the judge seats by one so that judge *i* is not the
1589 /// author of candidate *i* whenever the roster has more than one agent.
1590 pub fn resolve_roles(&self) -> Result<ResolvedRoles> {
1591 if self.agents.is_empty() {
1592 bail!(
1593 "agent roster is empty: no agent CLI found on PATH and no \
1594 [[agents]] in the config. Run `magi init` to write a starter \
1595 magi.toml."
1596 );
1597 }
1598 Ok(ResolvedRoles {
1599 implementers: self.rotate(&self.roles.implementers, self.graph.candidates, 0)?,
1600 judges: self.rotate(&self.roles.judges, self.graph.judges, 1)?,
1601 reviewers: self.rotate(&self.roles.reviewers, self.graph.reviewers, 0)?,
1602 fixer: self
1603 .roles
1604 .fixer
1605 .as_deref()
1606 .map(|f| self.agent(f).cloned())
1607 .transpose()?,
1608 // Role resolution validates roster shape, but deliberately does
1609 // not preflight a CLI. The other graph seats have always deferred
1610 // that failure to invocation; doing it only for the conductor
1611 // made otherwise usable graph commands and `doctor` fail as one.
1612 conductor: match self.roles.conductor.as_ref().map(AgentChoice::ids) {
1613 Some(ids) if ids.len() == 1 => self.agent(ids[0])?.clone(),
1614 // A fallback chain: the first id the roster knows. The rest
1615 // are `agent::pick_chain`'s business at invocation.
1616 Some(ids) if !ids.is_empty() => ids
1617 .iter()
1618 .find_map(|id| self.agent(id).ok())
1619 .cloned()
1620 .with_context(|| {
1621 format!("[roles] conductor names no agent in the roster: {ids:?}")
1622 })?,
1623 // Keep the normal standalone-seat preference when something
1624 // is installed, but retain a roster fallback when it is not.
1625 // Invocation then reports the unavailable CLI in the same
1626 // place it does for every other graph role.
1627 _ => crate::agent::pick(&self.agents, None, &crate::agent::installed)
1628 .unwrap_or_else(|_| self.agents[0].clone()),
1629 },
1630 implementer_roster: self.full_roster(&self.roles.implementers)?,
1631 judge_roster: self.full_roster(&self.roles.judges)?,
1632 reviewer_roster: self.full_roster(&self.roles.reviewers)?,
1633 })
1634 }
1635
1636 /// Advisor seats for the design-deliberation stage (see
1637 /// `graph::Runner::advise`): `[roles] advisors` when set, otherwise the
1638 /// judge roster - see [`Roles::advisors`] for why that fallback and not
1639 /// the whole roster.
1640 ///
1641 /// The fallback rotates with `offset = 1`, matching the judges line in
1642 /// [`Config::resolve_roles`] exactly, `ids` and offset both - not just
1643 /// `roles.judges`, which is empty whenever judges themselves are
1644 /// unconfigured and rotating the whole roster. Falling back with
1645 /// `offset = 0` there would silently hand the advisors a *different*
1646 /// agent set than the judges an unconfigured run would actually get,
1647 /// which is the one thing [`Roles::advisors`]'s doc promises will not
1648 /// happen.
1649 ///
1650 /// Called lazily from the graph node itself rather than folded into
1651 /// [`Config::resolve_roles`]: unlike the other roles, a failure here must
1652 /// not stop a run from starting at all - the deliberation stage is an
1653 /// enrichment `[graph] advise` can turn off, not a seat later nodes
1654 /// cannot proceed without - and at the point `resolve_roles` runs (before
1655 /// [`crate::run::RunState`] exists, on `Runner::start`) there would be no
1656 /// run yet for a resolution failure to be reported against.
1657 pub fn advisors(&self) -> Result<Vec<AgentSpec>> {
1658 if self.agents.is_empty() {
1659 bail!(
1660 "agent roster is empty: no agent CLI found on PATH and no \
1661 [[agents]] in the config. Run `magi init` to write a starter \
1662 magi.toml."
1663 );
1664 }
1665 if !self.roles.advisors.is_empty() {
1666 return self.rotate(&self.roles.advisors, self.graph.advisors, 0);
1667 }
1668 self.rotate(&self.roles.judges, self.graph.advisors, 1)
1669 }
1670
1671 /// The untruncated roster advisor seats hand over along: `[roles]
1672 /// advisors` when set, otherwise the judges' roster, exactly as
1673 /// [`Self::advisors`] chooses its own list.
1674 pub fn advisor_roster(&self) -> Result<Vec<AgentSpec>> {
1675 if self.roles.advisors.is_empty() {
1676 self.full_roster(&self.roles.judges)
1677 } else {
1678 self.full_roster(&self.roles.advisors)
1679 }
1680 }
1681
1682 /// Shell prefix for [`Verify`] commands.
1683 pub fn shell(&self) -> Vec<String> {
1684 if let Some(s) = &self.verify.shell {
1685 return s.clone();
1686 }
1687 if which("sh") {
1688 vec!["sh".to_owned(), "-c".to_owned()]
1689 } else {
1690 vec!["cmd".to_owned(), "/C".to_owned()]
1691 }
1692 }
1693
1694 /// Starter config, as written by `magi init`.
1695 pub fn starter_toml() -> String {
1696 let detected = Self::autodetected();
1697 let mut s = String::from(
1698 "# magi — blind multi-agent implementation competition.\n\
1699 # `magi run \"<task>\"` walks: implement (N parallel worktrees)\n\
1700 # -> blind judging -> deliberation -> private final vote\n\
1701 # -> fold losers -> review + E2E loop -> gate -> merge.\n\
1702 #\n\
1703 # Rendered by teravars: a `[vars]` table, env\n\
1704 # and system lookups, and `include = [...]` all work. Tera\n\
1705 # braces are live everywhere in this file, but comments are\n\
1706 # stripped before rendering (teravars >= 0.2.2), so a comment\n\
1707 # may quote `{{ ... }}` freely.\n\
1708 #\n\
1709 # Layers deep-merge in increasing\n\
1710 # precedence, so the roster can live once per machine in\n\
1711 # <config_dir>/magi/config.toml and each repo only states its own\n\
1712 # gate:\n\
1713 # <config_dir>/magi/config.toml < .magi/config.toml < magi.toml\n\n\
1714 [vars]\n\
1715 # Reference it as vars.cache inside Tera braces, anywhere below.\n\
1716 # Single quotes inside the braces: teravars renders the raw file\n\
1717 # text, so TOML's own \\\" escaping never reaches Tera.\n\
1718 cache = \"{{ env.MAGI_CACHE | default(value='/tmp') }}\"\n\n",
1719 );
1720 if detected.agents.is_empty() {
1721 s.push_str(
1722 "# No agent CLI was found on PATH. Fill this in by hand.\n\
1723 # kind = claude | opencode | antigravity | codex | command\n\
1724 [[agents]]\nid = \"opus\"\nkind = \"claude\"\nmodel = \"opus\"\n\n",
1725 );
1726 } else {
1727 for a in &detected.agents {
1728 s.push_str("[[agents]]\n");
1729 s.push_str(&format!("id = {:?}\n", a.id));
1730 s.push_str(&format!("kind = {:?}\n", a.kind.as_str()));
1731 if let Some(m) = &a.model {
1732 s.push_str(&format!("model = {m:?}\n"));
1733 }
1734 s.push('\n');
1735 }
1736 }
1737 s.push_str(
1738 "# Leave a role list empty to rotate through the roster.\n\
1739 [roles]\n\
1740 implementers = []\n\
1741 judges = []\n\
1742 reviewers = []\n\
1743 # conductor = \"opus\" # arranges the queue; unset picks a seat like chatter does\n\
1744 # synthesizer = \"opus\" # blends the advisors into one brief; unset picks a seat like chatter does\n\
1745 # synthesizer = [\"opus\", \"codex\"] # array form: fallback chain, each tried once on quota or failure\n\n\
1746 [graph]\n\
1747 candidates = 3\n\
1748 judges = 3\n\
1749 deliberate_rounds = 1\n\
1750 reviewers = 3\n\
1751 review_rounds = 6\n\
1752 # Fix rounds a failing verify.gate gets before the run is blocked (0 = none).\n\
1753 gate_fix_rounds = 1\n\
1754 max_parallel = 4\n\
1755 language = \"en\"\n\
1756 # One CLI conversation per seat: judges keep their own argument\n\
1757 # across deliberation, the fixer keeps its implementation context.\n\
1758 sessions = true\n\
1759 # Reviewer-seat timeout. When timeout_verify is omitted, E2E and\n\
1760 # the final gate inherit this value for compatibility.\n\
1761 timeout_review = 1200\n\
1762 # Optional independent E2E/final-gate timeout; uncomment to keep\n\
1763 # verification independent if timeout_review changes later.\n\
1764 # timeout_verify = 1200\n\n\
1765 [verify]\n\
1766 # Run once per review round in the winner's worktree; failures are\n\
1767 # fed back to the fixer.\n\
1768 e2e = []\n\
1769 # Final gate. Every command must exit 0 before a merge.\n\
1770 gate = []\n\
1771 # Mechanical fixers (formatters) run in the winner's worktree just\n\
1772 # before the gate; whatever they change becomes one commit. A failing\n\
1773 # command only warns - the gate stays the arbiter. Same timeout as the\n\
1774 # gate (timeout_verify). Keep it light and idempotent.\n\
1775 # pre_gate = []\n\n\
1776 [merge]\n\
1777 # none | local | pr\n\
1778 mode = \"none\"\n\
1779 # release_bump = true # Rust (Cargo.toml) repositories only; a no-op elsewhere\n\n\
1780 [update]\n\
1781 # off | notify | install — checked in the background, throttled.\n\
1782 mode = \"notify\"\n\
1783 # interval = \"24h\"\n",
1784 );
1785 s
1786 }
1787}
1788
1789/// Is `program` on `PATH`?
1790pub fn which(program: &str) -> bool {
1791 find_program(program).is_some()
1792}
1793
1794/// The file a bare `program` name resolves to on `PATH`, the way the OS shell
1795/// would find it.
1796///
1797/// Spawn agents through this, not by bare name: on Windows Rust's std
1798/// only tries `name.exe`, so a CLI installed as an npm `.cmd` shim (codex
1799/// since its 2026-09-23 reinstall) is "not found" even though a shell runs it.
1800/// On Windows an extensionless file is never a match: npm writes an `sh`
1801/// script beside every `.cmd` shim, and spawning that fails with os error 193.
1802pub fn find_program(program: &str) -> Option<PathBuf> {
1803 find_program_on(program, &std::env::var_os("PATH")?)
1804}
1805
1806/// [`find_program`] against an explicit `PATH`, for a child whose environment
1807/// overrides it.
1808pub fn find_program_on(program: &str, paths: &std::ffi::OsStr) -> Option<PathBuf> {
1809 let pathext = std::env::var("PATHEXT").unwrap_or_else(|_| ".EXE;.CMD;.BAT".into());
1810 find_program_in(program, paths, cfg!(windows).then_some(pathext.as_str()))
1811}
1812
1813fn find_program_in(
1814 program: &str,
1815 paths: &std::ffi::OsStr,
1816 pathext: Option<&str>,
1817) -> Option<PathBuf> {
1818 let p = Path::new(program);
1819 if p.components().count() > 1 {
1820 return p.is_file().then(|| p.to_path_buf());
1821 }
1822 std::env::split_paths(paths).find_map(|dir| match pathext {
1823 Some(exts) => {
1824 let bare = dir.join(program);
1825 if p.extension().is_some() && bare.is_file() {
1826 return Some(bare);
1827 }
1828 exts.split(';')
1829 .filter(|e| !e.is_empty())
1830 .map(|e| dir.join(format!("{program}{}", e.to_lowercase())))
1831 .find(|c| c.is_file())
1832 }
1833 None => Some(dir.join(program)).filter(|c| c.is_file()),
1834 })
1835}
1836
1837#[cfg(test)]
1838mod tests {
1839 #[test]
1840 fn context_window_prefers_exact_then_longest_prefix_and_user_over_builtin() {
1841 let mut cfg = Config::default();
1842 assert_eq!(
1843 cfg.context_window("claude-sonnet-4-5-20250929"),
1844 Some(200_000)
1845 );
1846 assert_eq!(cfg.context_window("gpt-4.1-mini"), Some(1_000_000));
1847 assert_eq!(cfg.context_window("mystery-model"), None);
1848 cfg.context_windows
1849 .insert("claude-sonnet-4-5".into(), 1_000_000);
1850 cfg.context_windows.insert("claude-sonnet-4".into(), 5);
1851 cfg.context_windows.insert("mystery".into(), 32_768);
1852 // Longest user prefix beats a shorter one and the built-in table.
1853 assert_eq!(
1854 cfg.context_window("claude-sonnet-4-5-20250929"),
1855 Some(1_000_000)
1856 );
1857 // An exact name beats any prefix.
1858 cfg.context_windows
1859 .insert("claude-sonnet-4-5-20250929".into(), 7);
1860 assert_eq!(cfg.context_window("claude-sonnet-4-5-20250929"), Some(7));
1861 assert_eq!(cfg.context_window("mystery-model"), Some(32_768));
1862 }
1863
1864 use super::*;
1865
1866 /// npm writes an extensionless `sh` script beside `codex.cmd`; on Windows
1867 /// the `.cmd` is the spawnable one (os error 193 otherwise, 2026-09-23).
1868 #[test]
1869 fn windows_lookup_picks_the_cmd_shim_over_the_extensionless_script() {
1870 let dir = tempfile::tempdir().unwrap();
1871 std::fs::write(dir.path().join("codex"), "#!/bin/sh\n").unwrap();
1872 std::fs::write(dir.path().join("codex.cmd"), "@echo off\n").unwrap();
1873 let paths = dir.path().as_os_str();
1874 assert_eq!(
1875 find_program_in("codex", paths, Some(".EXE;.CMD")),
1876 Some(dir.path().join("codex.cmd"))
1877 );
1878 assert_eq!(
1879 find_program_in("codex", paths, None),
1880 Some(dir.path().join("codex"))
1881 );
1882 assert_eq!(find_program_in("claude", paths, Some(".EXE;.CMD")), None);
1883 }
1884
1885 fn spec(id: &str) -> AgentSpec {
1886 AgentSpec {
1887 id: id.to_owned(),
1888 kind: AgentKind::Command,
1889 model: None,
1890 command: vec!["true".to_owned()],
1891 extra_args: Vec::new(),
1892 env: BTreeMap::new(),
1893 prompt_delivery: None,
1894 }
1895 }
1896
1897 #[test]
1898 fn timeout_verify_omitted_from_old_toml_inherits_timeout_review() {
1899 // `timeout_verify` used to not exist: `verify.e2e`/`verify.gate` ran
1900 // under `timeout_review`. A config written before this field existed
1901 // must run exactly as before, which means its default has to be the
1902 // same 1200s `timeout_review` has always defaulted to.
1903 let g: Graph = toml::from_str("timeout_review = 3600").expect("parse");
1904 assert_eq!(g.timeout_verify, None);
1905 assert_eq!(g.verify_timeout(), 3600);
1906 }
1907
1908 #[test]
1909 fn shrinking_timeout_review_does_not_shrink_timeout_verify() {
1910 // The bug this field exists to close: `[graph] timeout_review = 45`
1911 // used to shrink the real-machine `verify.e2e`/`verify.gate` budget
1912 // along with the reviewer seats' own timeout, because both read the
1913 // same field.
1914 let g: Graph = toml::from_str("timeout_review = 45").expect("parse");
1915 assert_eq!(g.timeout_review, 45);
1916 assert_eq!(
1917 g.verify_timeout(),
1918 45,
1919 "an omitted legacy value follows review"
1920 );
1921 let explicit: Graph = toml::from_str("timeout_review = 45\ntimeout_verify = 1200")
1922 .expect("parse explicit override");
1923 assert_eq!(explicit.verify_timeout(), 1200);
1924 }
1925
1926 #[test]
1927 fn a_toml_layer_written_before_these_fields_existed_still_parses() {
1928 // `deny_unknown_fields` cuts both ways: a config from before
1929 // `timeout_verify`/`e2e_every_round` existed must still parse, with
1930 // both defaulted rather than refused as unknown-in-reverse.
1931 let g: Graph =
1932 toml::from_str("candidates = 1\nreviewers = 3\nreview_rounds = 6\nmax_parallel = 4\n")
1933 .expect("an old-shaped [graph] table must still parse");
1934 assert_eq!(g.verify_timeout(), Graph::default().timeout_review);
1935 assert!(
1936 !g.e2e_every_round,
1937 "off by default, same as before this field existed"
1938 );
1939 }
1940
1941 #[test]
1942 fn empty_roles_rotate_judges_off_their_own_candidate() {
1943 // Three seats, said out loud: this is a test about *rotation*, and it
1944 // has nothing to say about how many candidates a task buys by default.
1945 let cfg = Config {
1946 agents: vec![spec("a"), spec("b"), spec("c")],
1947 graph: Graph {
1948 candidates: 3,
1949 ..Graph::default()
1950 },
1951 ..Config::default()
1952 };
1953 let roles = cfg.resolve_roles().unwrap();
1954 let impls: Vec<&str> = roles.implementers.iter().map(|a| a.id.as_str()).collect();
1955 let judges: Vec<&str> = roles.judges.iter().map(|a| a.id.as_str()).collect();
1956 assert_eq!(impls, ["a", "b", "c"]);
1957 assert_eq!(judges, ["b", "c", "a"]);
1958 for (i, j) in judges.iter().enumerate() {
1959 assert_ne!(*j, impls[i], "judge {i} must not sit on its own candidate");
1960 }
1961 }
1962
1963 #[test]
1964 fn single_agent_roster_fills_every_seat() {
1965 let cfg = Config {
1966 agents: vec![spec("solo")],
1967 graph: Graph {
1968 candidates: 3,
1969 ..Graph::default()
1970 },
1971 ..Config::default()
1972 };
1973 let roles = cfg.resolve_roles().unwrap();
1974 assert_eq!(roles.implementers.len(), 3);
1975 assert!(roles.judges.iter().all(|a| a.id == "solo"));
1976 }
1977
1978 #[test]
1979 fn implementer_roster_is_the_whole_agent_list_untruncated_when_unset() {
1980 // `candidates = 1` (a solo run) still resolves `implementers` down to
1981 // one slot, but `implementer_roster` must carry every agent in the
1982 // roster, in file order, for `graph::Runner`'s quota fallback to walk
1983 // forward through once that one slot's agent runs out of quota.
1984 let cfg = Config {
1985 agents: vec![spec("a"), spec("b"), spec("c")],
1986 graph: Graph {
1987 candidates: 1,
1988 ..Graph::default()
1989 },
1990 ..Config::default()
1991 };
1992 let roles = cfg.resolve_roles().unwrap();
1993 assert_eq!(roles.implementers.len(), 1);
1994 let roster: Vec<&str> = roles
1995 .implementer_roster
1996 .iter()
1997 .map(|a| a.id.as_str())
1998 .collect();
1999 assert_eq!(roster, ["a", "b", "c"]);
2000 }
2001
2002 #[test]
2003 fn implementer_roster_follows_explicit_ids_in_the_order_named() {
2004 let cfg = Config {
2005 agents: vec![spec("a"), spec("b"), spec("c")],
2006 roles: Roles {
2007 implementers: vec!["c".to_owned(), "a".to_owned()],
2008 ..Roles::default()
2009 },
2010 graph: Graph {
2011 candidates: 1,
2012 ..Graph::default()
2013 },
2014 ..Config::default()
2015 };
2016 let roles = cfg.resolve_roles().unwrap();
2017 // Unaffected by the new field: still just the first named id.
2018 assert_eq!(roles.implementers.len(), 1);
2019 assert_eq!(roles.implementers[0].id, "c");
2020 let roster: Vec<&str> = roles
2021 .implementer_roster
2022 .iter()
2023 .map(|a| a.id.as_str())
2024 .collect();
2025 assert_eq!(roster, ["c", "a"]);
2026 }
2027
2028 #[test]
2029 fn explicit_roles_win() {
2030 let cfg = Config {
2031 agents: vec![spec("a"), spec("b")],
2032 roles: Roles {
2033 implementers: vec!["b".to_owned()],
2034 judges: vec!["a".to_owned()],
2035 reviewers: Vec::new(),
2036 fixer: Some("a".to_owned()),
2037 ..Roles::default()
2038 },
2039 ..Config::default()
2040 };
2041 let roles = cfg.resolve_roles().unwrap();
2042 assert!(roles.implementers.iter().all(|a| a.id == "b"));
2043 assert!(roles.judges.iter().all(|a| a.id == "a"));
2044 assert_eq!(roles.fixer.unwrap().id, "a");
2045 assert_eq!(roles.conductor.id, "a");
2046 }
2047
2048 #[test]
2049 fn unknown_agent_id_is_an_error() {
2050 let cfg = Config {
2051 agents: vec![spec("a")],
2052 roles: Roles {
2053 judges: vec!["nope".to_owned()],
2054 ..Roles::default()
2055 },
2056 ..Config::default()
2057 };
2058 assert!(cfg.resolve_roles().is_err());
2059 }
2060
2061 #[test]
2062 fn conductor_role_is_resolved_validated_and_has_a_fallback() {
2063 let mut cfg = Config {
2064 agents: vec![spec("a"), spec("b")],
2065 ..Config::default()
2066 };
2067 assert_eq!(cfg.resolve_roles().unwrap().conductor.id, "a");
2068
2069 cfg.roles.conductor = Some("b".into());
2070 assert_eq!(cfg.resolve_roles().unwrap().conductor.id, "b");
2071
2072 cfg.roles.conductor = Some("missing".into());
2073 assert!(cfg.resolve_roles().is_err());
2074 }
2075
2076 #[test]
2077 fn a_standalone_role_takes_a_string_or_an_array_and_round_trips() {
2078 let one: Roles = toml::from_str("synthesizer = \"opus\"").unwrap();
2079 assert_eq!(one.synthesizer, Some(AgentChoice::One("opus".to_owned())));
2080 assert_eq!(primary(one.synthesizer.as_ref()), Some("opus"));
2081
2082 let chain: Roles = toml::from_str("chatter = [\"opus\", \"codex\"]").unwrap();
2083 assert_eq!(chain.chatter.as_ref().unwrap().ids(), ["opus", "codex"]);
2084 assert_eq!(primary(chain.chatter.as_ref()), Some("opus"));
2085
2086 for roles in [one, chain] {
2087 let text = toml::to_string(&roles).unwrap();
2088 let back: Roles = toml::from_str(&text).unwrap();
2089 assert_eq!(back.synthesizer, roles.synthesizer);
2090 assert_eq!(back.chatter, roles.chatter);
2091 }
2092 let text = toml::to_string(&Roles {
2093 conductor: Some("x".into()),
2094 ..Roles::default()
2095 })
2096 .unwrap();
2097 assert!(
2098 text.contains("conductor = \"x\""),
2099 "string stays a string: {text}"
2100 );
2101 assert!(toml::from_str::<Roles>("synthesizer = 3").is_err());
2102 }
2103
2104 #[test]
2105 fn an_empty_choice_counts_as_unset() {
2106 assert!(AgentChoice::Chain(Vec::new()).ids().is_empty());
2107 assert!(AgentChoice::One(" ".to_owned()).ids().is_empty());
2108 assert_eq!(primary(Some(&AgentChoice::Chain(vec![]))), None);
2109 }
2110
2111 #[test]
2112 fn synthesizer_role_is_a_lazy_lookup_with_the_same_fallback_as_chatter() {
2113 // Unlike `conductor`, `synthesizer` is never validated by
2114 // `resolve_roles` — it is looked up lazily by
2115 // `graph::Runner::synthesize_brief` the same way `[roles] chatter`
2116 // is looked up by `talk::begin`, so this exercises `agent::pick`
2117 // directly instead of going through `resolve_roles`.
2118 let mut cfg = Config {
2119 agents: vec![spec("a"), spec("b")],
2120 ..Config::default()
2121 };
2122 let want = primary(cfg.roles.synthesizer.as_ref());
2123 assert_eq!(
2124 crate::agent::pick(&cfg.agents, want, &crate::agent::installed)
2125 .unwrap()
2126 .id,
2127 "a",
2128 "unset falls back to agent::pick's own default order"
2129 );
2130
2131 cfg.roles.synthesizer = Some("b".into());
2132 let want = primary(cfg.roles.synthesizer.as_ref());
2133 assert_eq!(
2134 crate::agent::pick(&cfg.agents, want, &crate::agent::installed)
2135 .unwrap()
2136 .id,
2137 "b",
2138 "the named agent wins over the default order"
2139 );
2140 }
2141
2142 #[test]
2143 fn empty_roster_is_an_error() {
2144 assert!(Config::default().resolve_roles().is_err());
2145 }
2146
2147 #[test]
2148 fn advise_defaults_to_on_with_three_proposals() {
2149 let g = Graph::default();
2150 assert!(g.advise);
2151 assert_eq!(g.advisors, 3);
2152 }
2153
2154 #[test]
2155 fn unset_advisors_falls_back_to_the_judge_roster() {
2156 let cfg = Config {
2157 agents: vec![spec("a"), spec("b")],
2158 roles: Roles {
2159 judges: vec!["b".to_owned()],
2160 ..Roles::default()
2161 },
2162 graph: Graph {
2163 advisors: 2,
2164 ..Graph::default()
2165 },
2166 ..Config::default()
2167 };
2168 let advisors = cfg.advisors().expect("advisors resolve");
2169 assert_eq!(advisors.len(), 2);
2170 assert!(
2171 advisors.iter().all(|a| a.id == "b"),
2172 "an unset [roles] advisors must fall back to [roles] judges: {advisors:?}"
2173 );
2174 }
2175
2176 #[test]
2177 fn an_explicit_advisor_roster_wins_over_the_judge_fallback() {
2178 let cfg = Config {
2179 agents: vec![spec("a"), spec("b")],
2180 roles: Roles {
2181 judges: vec!["b".to_owned()],
2182 advisors: vec!["a".to_owned()],
2183 ..Roles::default()
2184 },
2185 graph: Graph {
2186 advisors: 2,
2187 ..Graph::default()
2188 },
2189 ..Config::default()
2190 };
2191 let advisors = cfg.advisors().expect("advisors resolve");
2192 assert!(advisors.iter().all(|a| a.id == "a"));
2193 }
2194
2195 /// Neither `[roles] advisors` nor `[roles] judges` set: an unconfigured
2196 /// advisor roster must resolve to the exact same agents an unconfigured
2197 /// judge panel would get - same ids, same rotation offset - or the
2198 /// promise in [`Roles::advisors`]'s doc ("advisor diversity for free")
2199 /// does not actually hold.
2200 #[test]
2201 fn an_unconfigured_advisor_and_judge_roster_resolve_to_the_same_agents() {
2202 let cfg = Config {
2203 agents: vec![spec("a"), spec("b"), spec("c")],
2204 graph: Graph {
2205 advisors: 3,
2206 judges: 3,
2207 ..Graph::default()
2208 },
2209 ..Config::default()
2210 };
2211 let advisors = cfg.advisors().expect("advisors resolve");
2212 let judges = cfg.resolve_roles().expect("roles resolve").judges;
2213 let advisor_ids: Vec<&str> = advisors.iter().map(|a| a.id.as_str()).collect();
2214 let judge_ids: Vec<&str> = judges.iter().map(|a| a.id.as_str()).collect();
2215 assert_eq!(
2216 advisor_ids, judge_ids,
2217 "an unconfigured advisor roster must be the same seats an unconfigured judge panel gets"
2218 );
2219 }
2220
2221 #[test]
2222 fn an_unresolvable_advisor_seat_is_an_error_naming_the_id() {
2223 let cfg = Config {
2224 agents: vec![spec("a")],
2225 roles: Roles {
2226 advisors: vec!["nope".to_owned()],
2227 ..Roles::default()
2228 },
2229 graph: Graph {
2230 advisors: 1,
2231 ..Graph::default()
2232 },
2233 ..Config::default()
2234 };
2235 let err = cfg.advisors().expect_err("`nope` is not in the roster");
2236 assert!(format!("{err:#}").contains("nope"));
2237 }
2238
2239 #[test]
2240 fn repos_default_to_no_roots_and_a_day_of_trust() {
2241 assert_eq!(Config::default().repos.roots, Vec::<PathBuf>::new());
2242 assert_eq!(Config::default().repos.scan_ttl, 86_400);
2243 assert_eq!(Config::default().repos.fetch_interval, 600);
2244 }
2245
2246 #[test]
2247 fn a_config_file_with_no_repos_table_still_loads() {
2248 let dir = tempfile::tempdir().unwrap();
2249 let path = dir.path().join("magi.toml");
2250 std::fs::write(&path, "[graph]\ncandidates = 2\n").unwrap();
2251 let cfg = Config::load(&path).expect("must load without [repos]");
2252 assert_eq!(cfg.repos.roots, Vec::<PathBuf>::new());
2253 assert_eq!(cfg.repos.scan_ttl, 86_400);
2254 }
2255
2256 /// A fixture is the whole config under test.
2257 ///
2258 /// `layers` used to reach for `dirs::config_dir()` unconditionally, so on
2259 /// a machine where somebody had written `<config_dir>/magi/config.toml`
2260 /// the suite silently loaded it as the lowest layer. Adding `[repos]
2261 /// roots` there turned two web tests red - their fixtures declare
2262 /// `[repos] roots` too, and `refuse_split_arrays` rightly refuses one
2263 /// array key spread across two layers. CI stayed green throughout,
2264 /// because a runner has no such file: the suite failed only where magi is
2265 /// actually used.
2266 ///
2267 /// So a test build has no machine layer unless it asks for one, and this
2268 /// is that promise. Written against a real file at the real location so
2269 /// it fails if `machine_layer` starts reading it again.
2270 #[test]
2271 fn a_test_build_does_not_read_the_operators_machine_config() {
2272 let repo = tempfile::tempdir().unwrap();
2273 std::fs::write(repo.path().join("magi.toml"), "[graph]\ncandidates = 2\n").unwrap();
2274
2275 let layers = Config::layers(repo.path());
2276 assert_eq!(
2277 layers,
2278 vec![repo.path().join("magi.toml")],
2279 "only the fixture's own file may be a layer"
2280 );
2281 if let Some(real) = dirs::config_dir() {
2282 let machine = real.join("magi").join("config.toml");
2283 assert!(
2284 !layers.contains(&machine),
2285 "the operator's {} must not be a layer in a test build",
2286 machine.display()
2287 );
2288 }
2289 }
2290
2291 #[test]
2292 fn starter_toml_loads_through_teravars() {
2293 let dir = tempfile::tempdir().unwrap();
2294 let path = dir.path().join("magi.toml");
2295 std::fs::write(&path, Config::starter_toml()).unwrap();
2296 let parsed = Config::load(&path).expect("starter config must load");
2297 assert_eq!(parsed.graph.candidates, 3);
2298 assert_eq!(parsed.merge.mode, MergeMode::None);
2299 assert_eq!(parsed.merge.style, MergeStyle::Merge);
2300 assert!(parsed.graph.sessions);
2301 assert_eq!(parsed.graph.timeout_review, 1200);
2302 assert_eq!(parsed.graph.verify_timeout(), 1200);
2303 assert_eq!(parsed.update.mode, UpdateMode::Notify);
2304 }
2305
2306 #[test]
2307 fn pre_gate_defaults_to_empty_and_the_starter_documents_it() {
2308 let dir = tempfile::tempdir().unwrap();
2309 let path = dir.path().join("magi.toml");
2310 std::fs::write(&path, Config::starter_toml()).unwrap();
2311 assert!(Config::load(&path).unwrap().verify.pre_gate.is_empty());
2312 assert!(Config::starter_toml().contains("# pre_gate = []"));
2313 }
2314
2315 #[test]
2316 fn starter_toml_explains_inherited_and_explicit_verify_timeouts() {
2317 let starter = Config::starter_toml();
2318 assert!(starter.contains("When timeout_verify is omitted, E2E and"));
2319 assert!(starter.contains("verification independent if timeout_review changes later"));
2320 assert!(starter.contains("# timeout_verify = 1200"));
2321 }
2322
2323 /// A repository whose ruleset forbids merge commits declares that once,
2324 /// here, rather than magi asking GitHub about it on every render (see
2325 /// [`MergeStyle`]'s own doc for why).
2326 #[test]
2327 fn a_repository_can_declare_a_linear_history_merge_style() {
2328 let dir = tempfile::tempdir().unwrap();
2329 let path = dir.path().join("magi.toml");
2330 std::fs::write(&path, "[merge]\nmode = \"none\"\nstyle = \"squash\"\n").unwrap();
2331 let parsed = Config::load(&path).expect("config must load");
2332 assert_eq!(parsed.merge.style, MergeStyle::Squash);
2333 }
2334
2335 #[test]
2336 fn later_layers_win_and_vars_render() {
2337 let dir = tempfile::tempdir().unwrap();
2338 let machine = dir.path().join("machine.toml");
2339 let project = dir.path().join("magi.toml");
2340 // The machine layer owns the roster...
2341 std::fs::write(
2342 &machine,
2343 "[[agents]]\nid = \"opus\"\nkind = \"claude\"\nmodel = \"opus\"\n\n\
2344 [graph]\ncandidates = 3\nmax_parallel = 8\n",
2345 )
2346 .unwrap();
2347 // ...and the project layer only states what is repo-specific, plus a
2348 // `[vars]` value interpolated into a command.
2349 std::fs::write(
2350 &project,
2351 "[vars]\ncache = \"/shared\"\n\n\
2352 [graph]\ncandidates = 2\n\n\
2353 [verify]\ngate = [\"CARGO_TARGET_DIR={{ vars.cache }}/t cargo test\"]\n",
2354 )
2355 .unwrap();
2356
2357 let cfg = Config::load_layers(&[machine, project]).expect("layered load");
2358 assert_eq!(cfg.agents.len(), 1, "roster comes from the machine layer");
2359 assert_eq!(cfg.graph.candidates, 2, "project layer wins");
2360 assert_eq!(cfg.graph.max_parallel, 8, "machine layer survives");
2361 assert_eq!(
2362 cfg.verify.gate,
2363 ["CARGO_TARGET_DIR=/shared/t cargo test".to_owned()]
2364 );
2365 // The rendered command is where the cache path is read back from.
2366 assert_eq!(cfg.cache_dir(), Some(PathBuf::from("/shared/t")));
2367 }
2368
2369 #[test]
2370 fn talk_defaults_to_an_hour_and_an_unwritten_config_still_gets_it() {
2371 // An operator who writes no `[graph]` timeout keys at all must still
2372 // land on the hour, not on the five/fifteen minutes this turn used
2373 // to hardcode before it read from config.
2374 let g = Graph::default();
2375 assert_eq!(g.timeout_talk, 3600);
2376
2377 let dir = tempfile::tempdir().unwrap();
2378 let path = dir.path().join("magi.toml");
2379 std::fs::write(&path, "[graph]\ncandidates = 2\n").unwrap();
2380 let cfg = Config::load(&path).expect("must load without timeout_talk set");
2381 assert_eq!(cfg.graph.timeout_talk, 3600);
2382 }
2383
2384 #[test]
2385 fn an_overridden_talk_timeout_reaches_the_loaded_config() {
2386 let dir = tempfile::tempdir().unwrap();
2387 let path = dir.path().join("magi.toml");
2388 std::fs::write(&path, "[graph]\ntimeout_talk = 120\n").unwrap();
2389 let cfg = Config::load(&path).expect("must load");
2390 assert_eq!(cfg.graph.timeout_talk, 120);
2391 }
2392
2393 #[test]
2394 fn the_disk_defaults_are_the_measurements_made_up_front() {
2395 let cfg = Config::default();
2396 assert_eq!(cfg.disk.min_free_bytes, 8 * 1024 * 1024 * 1024);
2397 assert!(cfg.disk.auto_fold);
2398 assert_eq!(cfg.disk.fold_grace_secs, 6 * 60 * 60);
2399 assert_eq!(cfg.disk.cache_limit_bytes, 10 * 1024 * 1024 * 1024);
2400 }
2401
2402 #[test]
2403 fn an_unset_disk_section_is_the_safe_default() {
2404 let dir = tempfile::tempdir().unwrap();
2405 std::fs::write(dir.path().join("magi.toml"), "[graph]\ncandidates = 1\n").unwrap();
2406 let cfg = Config::load(&dir.path().join("magi.toml")).expect("load");
2407 assert_eq!(cfg.disk, Disk::default());
2408 }
2409
2410 #[test]
2411 fn env_is_available_to_templates_with_a_default() {
2412 let dir = tempfile::tempdir().unwrap();
2413 let path = dir.path().join("magi.toml");
2414 // teravars ships no `env`; magi adds it, and the `default` filter has
2415 // to cover the unset case or every machine would need the variable.
2416 //
2417 // Deliberately no named variable: `env` is keyed by the exact spelling
2418 // the OS reports, and Windows says `Path` where POSIX says `PATH`, so a
2419 // test asserting `env.PATH` passes on one runner and fails on another.
2420 // The map's non-emptiness is the platform-neutral claim.
2421 std::fs::write(
2422 &path,
2423 "[verify]\n\
2424 gate = [\"cache={{ env.MAGI_TEST_UNSET_XYZ | default(value='fallback') }}\", \
2425 \"populated={{ env | length > 0 }}\"]\n",
2426 )
2427 .unwrap();
2428 let cfg = Config::load(&path).expect("env lookup must render");
2429 assert_eq!(cfg.verify.gate[0], "cache=fallback");
2430 assert_eq!(cfg.verify.gate[1], "populated=true");
2431 }
2432
2433 #[test]
2434 fn a_broken_template_names_the_file() {
2435 let dir = tempfile::tempdir().unwrap();
2436 let path = dir.path().join("magi.toml");
2437 std::fs::write(&path, "[graph]\nlanguage = \"{{ nope.\"\n").unwrap();
2438 let err = Config::load(&path).expect_err("must not silently ignore");
2439 assert!(err.to_string().contains("teravars"), "{err}");
2440 }
2441
2442 #[test]
2443 fn tera_syntax_in_comments_is_inert() {
2444 // teravars >= 0.2.2 strips `#` comments before Tera sees the file, so a
2445 // comment may quote template syntax without rendering. Before 0.2.2 this
2446 // load failed: the commented-out braces reached the template parser.
2447 let dir = tempfile::tempdir().unwrap();
2448 let path = dir.path().join("magi.toml");
2449 std::fs::write(
2450 &path,
2451 "# a comment may quote templates: `{{ env.NOPE | default(value='x') }}` and `{% if %}`\n\
2452 [graph]\ncandidates = 2\n",
2453 )
2454 .unwrap();
2455 let cfg = Config::load(&path).expect("comments must be inert, not rendered");
2456 assert_eq!(cfg.graph.candidates, 2);
2457 }
2458
2459 #[test]
2460 fn opencode_defaults_to_file_delivery() {
2461 let mut s = spec("oc");
2462 s.kind = AgentKind::Opencode;
2463 assert_eq!(s.delivery(), Delivery::File);
2464 s.prompt_delivery = Some(Delivery::Argv);
2465 assert_eq!(s.delivery(), Delivery::Argv);
2466 }
2467 #[test]
2468 fn the_land_loop_is_on_but_it_cannot_merge_without_being_asked() {
2469 // Both default on, and that pair is the safety property: `land` takes
2470 // over the watching an operator was doing by hand, `land_approval`
2471 // keeps the irreversible step a human decision. An unattended merge
2472 // needs BOTH flipped, which has to be chosen deliberately twice.
2473 let g = Graph::default();
2474 assert!(
2475 g.land,
2476 "stopping at an open PR left the watching to a human"
2477 );
2478 assert!(
2479 g.land_approval,
2480 "on-by-default land is only defensible while this is also on"
2481 );
2482 assert!(g.land_rounds > 0, "a loop with no budget never terminates");
2483 assert!(
2484 g.hold_contested_merge,
2485 "a contested hand-off must still reach a human when approvals are off"
2486 );
2487 }
2488 #[test]
2489 fn an_array_declared_in_two_layers_is_refused_instead_of_concatenated() {
2490 // teravars appends arrays. For an ordered list of seats, or an argv,
2491 // the concatenation is something neither file says - and the operator
2492 // pays for the extra seats by the token.
2493 let dir = tempfile::tempdir().unwrap();
2494 let machine = dir.path().join("machine.toml");
2495 let repo = dir.path().join("magi.toml");
2496 std::fs::write(&machine, "[roles]\nimplementers = [\"a\", \"b\"]\n").unwrap();
2497 std::fs::write(&repo, "[roles]\nimplementers = [\"oc\"]\n").unwrap();
2498
2499 let err = Config::load_layers(&[machine.clone(), repo.clone()])
2500 .expect_err("two layers naming one array must not merge silently")
2501 .to_string();
2502 assert!(err.contains("roles.implementers"), "{err}");
2503 // Both files are named: the fix is to delete one of them, and the
2504 // operator has to know which two to choose between.
2505 assert!(err.contains("machine.toml"), "{err}");
2506 assert!(err.contains("magi.toml"), "{err}");
2507 }
2508
2509 #[test]
2510 fn a_scalar_in_one_layer_and_an_array_in_another_still_merges() {
2511 // The split the layering exists for: state a preference machine-wide,
2512 // let the repository own its own lists.
2513 let dir = tempfile::tempdir().unwrap();
2514 let machine = dir.path().join("machine.toml");
2515 let repo = dir.path().join("magi.toml");
2516 std::fs::write(&machine, "[roles]\nchatter = \"opus\"\n").unwrap();
2517 std::fs::write(
2518 &repo,
2519 "[[agents]]\nid = \"oc\"\nkind = \"opencode\"\n\n\
2520 [roles]\nimplementers = [\"oc\"]\n",
2521 )
2522 .unwrap();
2523
2524 let cfg = Config::load_layers(&[machine, repo]).expect("layers merge");
2525 assert_eq!(primary(cfg.roles.chatter.as_ref()), Some("opus"));
2526 assert_eq!(cfg.roles.implementers, ["oc"]);
2527 assert_eq!(cfg.agents.len(), 1, "the roster is not doubled");
2528 }
2529
2530 #[test]
2531 fn two_layers_declaring_verify_gate_run_both_in_priority_order() {
2532 // The `editorconfig-checker` distribution problem: a shared layer
2533 // wants to add a gate command without erasing the repository's own.
2534 let dir = tempfile::tempdir().unwrap();
2535 let machine = dir.path().join("machine.toml");
2536 let repo = dir.path().join("magi.toml");
2537 std::fs::write(&machine, "[verify]\ngate = [\"editorconfig-checker\"]\n").unwrap();
2538 std::fs::write(&repo, "[verify]\ngate = [\"cargo make check\"]\n").unwrap();
2539
2540 let cfg = Config::load_layers(&[machine, repo]).expect("appendable arrays must merge");
2541 assert_eq!(
2542 cfg.verify.gate,
2543 [
2544 "editorconfig-checker".to_owned(),
2545 "cargo make check".to_owned()
2546 ],
2547 "low-priority (machine) command first, high-priority (repo) command after"
2548 );
2549 }
2550
2551 #[test]
2552 fn two_layers_declaring_verify_e2e_run_both_in_priority_order() {
2553 let dir = tempfile::tempdir().unwrap();
2554 let machine = dir.path().join("machine.toml");
2555 let repo = dir.path().join("magi.toml");
2556 std::fs::write(&machine, "[verify]\ne2e = [\"shared-smoke-test\"]\n").unwrap();
2557 std::fs::write(&repo, "[verify]\ne2e = [\"cargo test\"]\n").unwrap();
2558
2559 let cfg = Config::load_layers(&[machine, repo]).expect("appendable arrays must merge");
2560 assert_eq!(
2561 cfg.verify.e2e,
2562 ["shared-smoke-test".to_owned(), "cargo test".to_owned()]
2563 );
2564 }
2565
2566 #[test]
2567 fn two_layers_declaring_repos_roots_are_both_scanned() {
2568 let dir = tempfile::tempdir().unwrap();
2569 let machine = dir.path().join("machine.toml");
2570 let repo = dir.path().join("magi.toml");
2571 std::fs::write(&machine, "[repos]\nroots = [\"/machine/root\"]\n").unwrap();
2572 std::fs::write(&repo, "[repos]\nroots = [\"/repo/root\"]\n").unwrap();
2573
2574 let cfg = Config::load_layers(&[machine, repo]).expect("appendable arrays must merge");
2575 assert_eq!(
2576 cfg.repos.roots,
2577 [PathBuf::from("/machine/root"), PathBuf::from("/repo/root")]
2578 );
2579 }
2580
2581 #[test]
2582 fn duplicate_gate_commands_across_layers_both_run() {
2583 // Dropping the duplicate would be a silent surprise; the operator
2584 // sees a slower gate, never a missing one.
2585 let dir = tempfile::tempdir().unwrap();
2586 let machine = dir.path().join("machine.toml");
2587 let repo = dir.path().join("magi.toml");
2588 std::fs::write(&machine, "[verify]\ngate = [\"same-command\"]\n").unwrap();
2589 std::fs::write(&repo, "[verify]\ngate = [\"same-command\"]\n").unwrap();
2590
2591 let cfg = Config::load_layers(&[machine, repo]).expect("appendable arrays must merge");
2592 assert_eq!(
2593 cfg.verify.gate,
2594 ["same-command".to_owned(), "same-command".to_owned()]
2595 );
2596 }
2597
2598 #[test]
2599 fn notify_command_is_still_refused_across_two_layers() {
2600 // An argv, not a set: concatenating two of them is not a program.
2601 let dir = tempfile::tempdir().unwrap();
2602 let machine = dir.path().join("machine.toml");
2603 let repo = dir.path().join("magi.toml");
2604 std::fs::write(&machine, "[notify]\ncommand = [\"ntfy\", \"publish\"]\n").unwrap();
2605 std::fs::write(&repo, "[notify]\ncommand = [\"curl\", \"-X\"]\n").unwrap();
2606
2607 let err = Config::load_layers(&[machine.clone(), repo.clone()])
2608 .expect_err("an argv split across layers must not concatenate")
2609 .to_string();
2610 assert!(err.contains("notify.command"), "{err}");
2611 assert!(err.contains("machine.toml"), "{err}");
2612 assert!(err.contains("magi.toml"), "{err}");
2613 }
2614
2615 #[test]
2616 fn one_layer_declaring_verify_gate_runs_unchanged() {
2617 // The classification must not change behaviour for the configuration
2618 // this very repository has today: exactly one layer names the gate.
2619 let dir = tempfile::tempdir().unwrap();
2620 let path = dir.path().join("magi.toml");
2621 std::fs::write(&path, "[verify]\ngate = [\"cargo make check\"]\n").unwrap();
2622
2623 let cfg = Config::load(&path).expect("single layer must still load");
2624 assert_eq!(cfg.verify.gate, ["cargo make check".to_owned()]);
2625 }
2626
2627 #[test]
2628 fn describe_composed_names_the_contributing_layers_only_when_there_are_two() {
2629 let dir = tempfile::tempdir().unwrap();
2630 let machine = dir.path().join("machine.toml");
2631 let repo = dir.path().join("magi.toml");
2632 std::fs::write(&machine, "[verify]\ngate = [\"editorconfig-checker\"]\n").unwrap();
2633 std::fs::write(&repo, "[verify]\ngate = [\"cargo make check\"]\n").unwrap();
2634 let paths = vec![machine.clone(), repo.clone()];
2635
2636 let cfg = Config::load_layers(&paths).expect("appendable arrays must merge");
2637 let described =
2638 Config::describe_composed(&paths, &cfg.verify.gate, "verify.gate", "(none)");
2639 assert!(described.contains("editorconfig-checker && cargo make check"));
2640 assert!(
2641 described.contains(&machine.display().to_string()),
2642 "{described}"
2643 );
2644 assert!(
2645 described.contains(&repo.display().to_string()),
2646 "{described}"
2647 );
2648
2649 // A single contributing layer stays the plain one-line summary.
2650 let single = vec![repo.clone()];
2651 let solo_cfg = Config::load_layers(&single).expect("single layer loads");
2652 let solo_described =
2653 Config::describe_composed(&single, &solo_cfg.verify.gate, "verify.gate", "(none)");
2654 assert_eq!(solo_described, "cargo make check");
2655 }
2656}