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