@kana-ai/edgar-contracts 0.1.2 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -9
- package/dist/config.schema.d.ts +1258 -0
- package/dist/js/schemas/ts/card.d.ts +8 -0
- package/dist/js/schemas/ts/card.js +1 -0
- package/dist/manifest.schema.d.ts +76 -1
- package/dist/rpc.schema.d.ts +161 -11
- package/dist/setup.schema.d.ts +49 -0
- package/package.json +1 -1
- package/schemas/json/config.schema.json +2111 -0
- package/schemas/json/manifest.schema.json +101 -2
- package/schemas/json/rpc.schema.json +218 -3
- package/schemas/json/setup.schema.json +97 -0
- package/schemas/ts/card.ts +1 -0
|
@@ -0,0 +1,1258 @@
|
|
|
1
|
+
/** Generated by json-schema-to-typescript from the schema of the same name. */
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Whether this role is turned off.
|
|
5
|
+
*/
|
|
6
|
+
export type TurnedOff = boolean;
|
|
7
|
+
/**
|
|
8
|
+
* How hard this role thinks: `low`, `medium`, `high` or `max`, in place of the role's own.
|
|
9
|
+
*/
|
|
10
|
+
export type Effort = Effort1 | null;
|
|
11
|
+
/**
|
|
12
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
13
|
+
* via the `definition` "Effort".
|
|
14
|
+
*/
|
|
15
|
+
export type Effort1 = "low" | "medium" | "high" | "max";
|
|
16
|
+
/**
|
|
17
|
+
* The providers this role moves to, in order, when its own is unavailable.
|
|
18
|
+
*/
|
|
19
|
+
export type FallbackProviders = string[] | null;
|
|
20
|
+
/**
|
|
21
|
+
* The provider this role runs on, such as `claude` or `codex`, in place of the role's own.
|
|
22
|
+
*/
|
|
23
|
+
export type Provider = string | null;
|
|
24
|
+
/**
|
|
25
|
+
* Whether a team comment on the card reaches a running stage of this role at the end of its turn, in place of starting a run, in place of the role's own `steer`.
|
|
26
|
+
*/
|
|
27
|
+
export type SteerFromComments = boolean | null;
|
|
28
|
+
/**
|
|
29
|
+
* Words an expected alert holds, matched as they are written; an alert that holds one gets no card.
|
|
30
|
+
*/
|
|
31
|
+
export type ExpectedAlerts = string[];
|
|
32
|
+
/**
|
|
33
|
+
* Where `edgar api` serves the API; `127.0.0.1:7400` when unset.
|
|
34
|
+
*/
|
|
35
|
+
export type APIAddress = string | null;
|
|
36
|
+
/**
|
|
37
|
+
* `{ extension = "<name>" }`: the enabled extension that says who sends each request by the host of `public_url`, from the headers that a sign-in proxy in front of EDGAR adds.
|
|
38
|
+
*/
|
|
39
|
+
export type IdentityExtension = IdentityExtension1 | null;
|
|
40
|
+
/**
|
|
41
|
+
* The address people open EDGAR at from another machine, through a reverse proxy, such as `https://edgar.example.com`.
|
|
42
|
+
*/
|
|
43
|
+
export type PublicURL = string | null;
|
|
44
|
+
/**
|
|
45
|
+
* A tool's approval word; a project may only make the manifest's word stricter.
|
|
46
|
+
*
|
|
47
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
48
|
+
* via the `definition` "ApprovalPolicy".
|
|
49
|
+
*/
|
|
50
|
+
export type ApprovalPolicy = "never" | "once" | "always" | "auto";
|
|
51
|
+
/**
|
|
52
|
+
* How many runs hold a sandbox at the same time; four for each slot when unset.
|
|
53
|
+
*/
|
|
54
|
+
export type SandboxesAtOnce = number | null;
|
|
55
|
+
/**
|
|
56
|
+
* How many stages run at the same time; the CPU count minus one when unset.
|
|
57
|
+
*/
|
|
58
|
+
export type StagesAtOnce = number | null;
|
|
59
|
+
/**
|
|
60
|
+
* How many questions the console's Ask panel may put to stage sessions each minute; 10 when unset.
|
|
61
|
+
*/
|
|
62
|
+
export type QuestionsPerMinute = number | null;
|
|
63
|
+
/**
|
|
64
|
+
* Where `edgar console` serves the console; `127.0.0.1:7401` when unset.
|
|
65
|
+
*/
|
|
66
|
+
export type ConsoleAddress = string | null;
|
|
67
|
+
/**
|
|
68
|
+
* Whether `edgar start` runs in the background, as `edgar start --daemon` does.
|
|
69
|
+
*/
|
|
70
|
+
export type RunInTheBackground = boolean;
|
|
71
|
+
/**
|
|
72
|
+
* An agent attempt that uses more tokens than this ends; no budget when unset.
|
|
73
|
+
*/
|
|
74
|
+
export type AgentTokenBudget = number | null;
|
|
75
|
+
/**
|
|
76
|
+
* An agent attempt that sends nothing for this many seconds ends as silent.
|
|
77
|
+
*/
|
|
78
|
+
export type AgentSilenceLimit = number | null;
|
|
79
|
+
/**
|
|
80
|
+
* The most seconds one agent attempt may take.
|
|
81
|
+
*/
|
|
82
|
+
export type AgentTimeLimit = number | null;
|
|
83
|
+
/**
|
|
84
|
+
* The most seconds one stage of this kind may take.
|
|
85
|
+
*/
|
|
86
|
+
export type TimeLimit = number | null;
|
|
87
|
+
/**
|
|
88
|
+
* The extensions this project uses, by name.
|
|
89
|
+
*/
|
|
90
|
+
export type EnabledExtensions = string[];
|
|
91
|
+
/**
|
|
92
|
+
* Hosts every call of this extension may reach, beside its manifest's own.
|
|
93
|
+
*/
|
|
94
|
+
export type ExtraHosts = string[];
|
|
95
|
+
/**
|
|
96
|
+
* What a hook that does not answer in time means: `pass` or `deny`.
|
|
97
|
+
*/
|
|
98
|
+
export type WhenAHookDoesNotAnswer = "pass" | "deny";
|
|
99
|
+
/**
|
|
100
|
+
* The hooks that judge each tool call, in order; removing `edgar__guardrails` drops its checks.
|
|
101
|
+
*/
|
|
102
|
+
export type HookOrder = string[];
|
|
103
|
+
/**
|
|
104
|
+
* How many runs one card starts in a day; past it, the card is handed back to a person once with a comment that says why, so a card that keeps failing cannot loop forever.
|
|
105
|
+
*/
|
|
106
|
+
export type RunsPerCardPerDay = number;
|
|
107
|
+
/**
|
|
108
|
+
* The longest comment EDGAR reads or writes on a card.
|
|
109
|
+
*/
|
|
110
|
+
export type LongestCommentBytes = number;
|
|
111
|
+
/**
|
|
112
|
+
* How many pull requests EDGAR opens in a day before a person must approve the next.
|
|
113
|
+
*/
|
|
114
|
+
export type PullRequestsPerDay = number | null;
|
|
115
|
+
/**
|
|
116
|
+
* How many pull requests EDGAR opens in an hour before a person must approve the next.
|
|
117
|
+
*/
|
|
118
|
+
export type PullRequestsPerHour = number | null;
|
|
119
|
+
/**
|
|
120
|
+
* The tool whose calls the caps count; `github__open_pull_request` when unset.
|
|
121
|
+
*/
|
|
122
|
+
export type ToolThatOpensAChange = string | null;
|
|
123
|
+
/**
|
|
124
|
+
* How many questions a stage marked `question` posts on the cards of one tracker in a UTC day; past it, a question waits for the next day, except on a critical or high card.
|
|
125
|
+
*/
|
|
126
|
+
export type QuestionsPerTrackerPerDay = number;
|
|
127
|
+
/**
|
|
128
|
+
* The most one run spends on model calls, in USD, with the sub-runs it starts; once its spend reaches this, the run starts no more work and ends failed. No budget when unset.
|
|
129
|
+
*/
|
|
130
|
+
export type BudgetPerRunUSD = number | null;
|
|
131
|
+
/**
|
|
132
|
+
* EDGAR merges its own pull request with no person only when it changes fewer files than this; `0` turns that off.
|
|
133
|
+
*/
|
|
134
|
+
export type FilesInASelfMerge = number;
|
|
135
|
+
/**
|
|
136
|
+
* How `edgar` writes its log: one line of text, or one JSON object, for each event.
|
|
137
|
+
*/
|
|
138
|
+
export type LogFormat = "text" | "json";
|
|
139
|
+
/**
|
|
140
|
+
* How many rotated log files a daemon keeps; 5 when unset.
|
|
141
|
+
*/
|
|
142
|
+
export type RotatedLogsKept = number | null;
|
|
143
|
+
/**
|
|
144
|
+
* The size at which a daemon's `edgar.log` rotates; 10 MiB when unset.
|
|
145
|
+
*/
|
|
146
|
+
export type LogSizeBeforeRotation = number | null;
|
|
147
|
+
/**
|
|
148
|
+
* Whether `/mcp` also answers requests forwarded for the public host name.
|
|
149
|
+
*/
|
|
150
|
+
export type RemoteMCP = boolean;
|
|
151
|
+
/**
|
|
152
|
+
* The public name a reverse proxy forwards to `/mcp`, such as `edgar.example.com`.
|
|
153
|
+
*/
|
|
154
|
+
export type RemoteMCPHost = string;
|
|
155
|
+
/**
|
|
156
|
+
* The person's email address.
|
|
157
|
+
*/
|
|
158
|
+
export type Email = string | null;
|
|
159
|
+
/**
|
|
160
|
+
* Whether EDGAR works and commits on the machine but pushes, opens and posts nothing, and logs each write it held back.
|
|
161
|
+
*/
|
|
162
|
+
export type DryRun = boolean;
|
|
163
|
+
/**
|
|
164
|
+
* The project's name; `edgar init` sets it to the folder's name.
|
|
165
|
+
*/
|
|
166
|
+
export type ProjectName = string;
|
|
167
|
+
/**
|
|
168
|
+
* The ACP agent's program and its arguments.
|
|
169
|
+
*/
|
|
170
|
+
export type AgentCommand = string[] | null;
|
|
171
|
+
/**
|
|
172
|
+
* The variable the API key reaches the ACP agent as; `ANTHROPIC_API_KEY` when unset.
|
|
173
|
+
*/
|
|
174
|
+
export type KeyVariable = string | null;
|
|
175
|
+
/**
|
|
176
|
+
* The vendor's model id every session of this provider asks for; the vendor's default when unset.
|
|
177
|
+
*/
|
|
178
|
+
export type Model = string | null;
|
|
179
|
+
/**
|
|
180
|
+
* US dollars for each million tokens, which give each model call its cost.
|
|
181
|
+
*/
|
|
182
|
+
export type Prices = Prices1 | null;
|
|
183
|
+
/**
|
|
184
|
+
* The people who may approve, deny, complete or cancel; everyone when empty.
|
|
185
|
+
*/
|
|
186
|
+
export type Operators = string[];
|
|
187
|
+
/**
|
|
188
|
+
* A provider or extension runtime with no work for this long exits.
|
|
189
|
+
*/
|
|
190
|
+
export type IdleSecondsBeforeARuntimeExits = number;
|
|
191
|
+
/**
|
|
192
|
+
* Commands refused by their first words, such as `pnpm deploy`.
|
|
193
|
+
*/
|
|
194
|
+
export type RefusedCommands = string[];
|
|
195
|
+
/**
|
|
196
|
+
* Where the token of a `[sandbox] git_tokens` host comes from: a `[secrets]` name, read once at start, or `{ extension = "<name>" }`, an enabled extension that mints one when git needs it, such as a GitHub App's installation token.
|
|
197
|
+
*
|
|
198
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
199
|
+
* via the `definition` "GitToken".
|
|
200
|
+
*/
|
|
201
|
+
export type GitToken =
|
|
202
|
+
| string
|
|
203
|
+
| {
|
|
204
|
+
extension: string;
|
|
205
|
+
};
|
|
206
|
+
/**
|
|
207
|
+
* The container image that commands run in when the sandbox kind is `container`.
|
|
208
|
+
*/
|
|
209
|
+
export type ContainerImage = string | null;
|
|
210
|
+
/**
|
|
211
|
+
* How long a run that waits for a person keeps its sandbox folder.
|
|
212
|
+
*/
|
|
213
|
+
export type HoursAWaitingRunKeepsItsSandbox = number;
|
|
214
|
+
/**
|
|
215
|
+
* How commands are isolated: a Git worktree, a container, or no isolation at all.
|
|
216
|
+
*/
|
|
217
|
+
export type SandboxKind = "worktree" | "container" | "none";
|
|
218
|
+
/**
|
|
219
|
+
* Kept work this many commits behind the default branch does not resume.
|
|
220
|
+
*/
|
|
221
|
+
export type CommitsBehindBeforeWorkRestarts = number;
|
|
222
|
+
/**
|
|
223
|
+
* EDGAR makes no new sandbox while the disk has less free space than this.
|
|
224
|
+
*/
|
|
225
|
+
export type FreeDiskNeededGB = number;
|
|
226
|
+
/**
|
|
227
|
+
* Hosts that every command in the sandbox may reach, such as a package registry.
|
|
228
|
+
*/
|
|
229
|
+
export type HostsEveryCommandReaches = string[];
|
|
230
|
+
/**
|
|
231
|
+
* Paths of the service checkout, globs allowed, that no read returns and no push carries.
|
|
232
|
+
*/
|
|
233
|
+
export type SecretFiles = string[];
|
|
234
|
+
/**
|
|
235
|
+
* Where the first version of EDGAR kept its pictures, such as `gs://example-pub`, read for an old `/pub/<id>.png` that `[storage]` does not hold.
|
|
236
|
+
*/
|
|
237
|
+
export type EarlierPictures = StorageLocation | null;
|
|
238
|
+
/**
|
|
239
|
+
* `gs://<bucket>[/<folder>]` or `s3://<bucket>[/<folder>]`.
|
|
240
|
+
*
|
|
241
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
242
|
+
* via the `definition` "StorageLocation".
|
|
243
|
+
*/
|
|
244
|
+
export type StorageLocation = string;
|
|
245
|
+
/**
|
|
246
|
+
* Where a secret comes from, in order of preference.
|
|
247
|
+
*
|
|
248
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
249
|
+
* via the `definition` "SecretSource".
|
|
250
|
+
*/
|
|
251
|
+
export type SecretSource =
|
|
252
|
+
| {
|
|
253
|
+
env: string;
|
|
254
|
+
}
|
|
255
|
+
| {
|
|
256
|
+
file: string;
|
|
257
|
+
}
|
|
258
|
+
| {
|
|
259
|
+
command: string[];
|
|
260
|
+
};
|
|
261
|
+
/**
|
|
262
|
+
* The program and its arguments that the check runs, never a shell string.
|
|
263
|
+
*/
|
|
264
|
+
export type CheckCommand = string[];
|
|
265
|
+
/**
|
|
266
|
+
* The most seconds this check may take; the check default when unset.
|
|
267
|
+
*/
|
|
268
|
+
export type CheckTimeLimit = number | null;
|
|
269
|
+
/**
|
|
270
|
+
* The branch each change of this service starts from.
|
|
271
|
+
*/
|
|
272
|
+
export type DefaultBranch = string;
|
|
273
|
+
/**
|
|
274
|
+
* The extension that runs the service's stack around its checks.
|
|
275
|
+
*/
|
|
276
|
+
export type RunningStack = Environment | null;
|
|
277
|
+
/**
|
|
278
|
+
* A note a pull request carries once when it changes a path under a given prefix.
|
|
279
|
+
*/
|
|
280
|
+
export type PathNotices = PathNotice[];
|
|
281
|
+
/**
|
|
282
|
+
* The command that installs the service's dependencies once for each content of its `inputs`, so each sandbox starts with them.
|
|
283
|
+
*/
|
|
284
|
+
export type PreparedDependencies = Prepare | null;
|
|
285
|
+
/**
|
|
286
|
+
* The Git address or folder of the service's repository.
|
|
287
|
+
*/
|
|
288
|
+
export type Repository = string;
|
|
289
|
+
/**
|
|
290
|
+
* The bucket that holds EDGAR's state off the machine.
|
|
291
|
+
*/
|
|
292
|
+
export type Bucket = string;
|
|
293
|
+
/**
|
|
294
|
+
* An S3-compatible service or an emulator to use in place of the vendor's own.
|
|
295
|
+
*/
|
|
296
|
+
export type StorageAddress = Endpoint | null;
|
|
297
|
+
/**
|
|
298
|
+
* `https://<host>[:port][/path]`, or `http://` to a loopback host only, with no user in it.
|
|
299
|
+
*
|
|
300
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
301
|
+
* via the `definition` "Endpoint".
|
|
302
|
+
*/
|
|
303
|
+
export type Endpoint = string;
|
|
304
|
+
/**
|
|
305
|
+
* The folder in the bucket that EDGAR writes under, such as `edgar/production`.
|
|
306
|
+
*/
|
|
307
|
+
export type FolderInTheBucket = string | null;
|
|
308
|
+
/**
|
|
309
|
+
* The vendor whose bucket holds EDGAR's state off the machine: `google` or `amazon`.
|
|
310
|
+
*/
|
|
311
|
+
export type CloudVendor = "google" | "amazon";
|
|
312
|
+
/**
|
|
313
|
+
* The Amazon region of the bucket; from the environment when unset.
|
|
314
|
+
*/
|
|
315
|
+
export type Region = string | null;
|
|
316
|
+
/**
|
|
317
|
+
* A program EDGAR runs after each copy, with the copy's path as its last argument.
|
|
318
|
+
*/
|
|
319
|
+
export type CommandAfterEachBackup = Argv | null;
|
|
320
|
+
/**
|
|
321
|
+
* A program and its arguments, run with no shell. A list with no program is refused as `C005`.
|
|
322
|
+
*
|
|
323
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
324
|
+
* via the `definition` "Argv".
|
|
325
|
+
*/
|
|
326
|
+
export type Argv = string[];
|
|
327
|
+
/**
|
|
328
|
+
* The minutes from one copy of the store to the next, at least 15.
|
|
329
|
+
*/
|
|
330
|
+
export type MinutesBetweenBackups = number;
|
|
331
|
+
/**
|
|
332
|
+
* EDGAR trims what runs said after this many days; `0` keeps everything.
|
|
333
|
+
*/
|
|
334
|
+
export type DaysKept = number;
|
|
335
|
+
/**
|
|
336
|
+
* Tools that this project turns off.
|
|
337
|
+
*/
|
|
338
|
+
export type TurnedOffTools = string[];
|
|
339
|
+
/**
|
|
340
|
+
* Tools that an extension ships turned off and this project turns on.
|
|
341
|
+
*/
|
|
342
|
+
export type TurnedOnTools = string[];
|
|
343
|
+
/**
|
|
344
|
+
* Hosts that a card's attachments may come from, beside the host of the card's own link.
|
|
345
|
+
*/
|
|
346
|
+
export type AttachmentHosts = string[];
|
|
347
|
+
/**
|
|
348
|
+
* The tracker that gets work with no card, in a project with more than one tracker.
|
|
349
|
+
*/
|
|
350
|
+
export type DefaultTracker = string | null;
|
|
351
|
+
/**
|
|
352
|
+
* The service of a card that names none, in a project with more than one service.
|
|
353
|
+
*/
|
|
354
|
+
export type DefaultService = string | null;
|
|
355
|
+
/**
|
|
356
|
+
* Whether a run that starts from a card first marks the card seen, with a reaction where the tracker has one, so the person who filed it knows EDGAR picked it up.
|
|
357
|
+
*/
|
|
358
|
+
export type MarkCardsSeen = boolean;
|
|
359
|
+
/**
|
|
360
|
+
* What the words of a person outside the team, as the tracker says, may start: `answers`, the workflows whose trigger does not ask for `trust = "team"`, such as triage and answers, or `nothing`.
|
|
361
|
+
*/
|
|
362
|
+
export type OutsideTheTeam = "answers" | "nothing";
|
|
363
|
+
/**
|
|
364
|
+
* How often EDGAR reads each tracker for new and changed cards.
|
|
365
|
+
*/
|
|
366
|
+
export type SecondsBetweenTrackerReads = number;
|
|
367
|
+
/**
|
|
368
|
+
* How often the worker looks for a newer release; 360 when unset.
|
|
369
|
+
*/
|
|
370
|
+
export type MinutesBetweenUpdateChecks = number | null;
|
|
371
|
+
/**
|
|
372
|
+
* Whether the worker looks for a newer release of EDGAR and installs it in the window.
|
|
373
|
+
*/
|
|
374
|
+
export type SelfUpdate = boolean;
|
|
375
|
+
/**
|
|
376
|
+
* The IANA zone that reads the update window, such as `Europe/Paris`; the machine's own zone when unset.
|
|
377
|
+
*/
|
|
378
|
+
export type TimeZone = string | null;
|
|
379
|
+
/**
|
|
380
|
+
* The one version EDGAR updates to; the newest stable release when unset.
|
|
381
|
+
*/
|
|
382
|
+
export type VersionToHold = string | null;
|
|
383
|
+
/**
|
|
384
|
+
* The time of night when the worker installs a newer release, as `HH:MM-HH:MM`; `00:00-06:00` when unset.
|
|
385
|
+
*/
|
|
386
|
+
export type UpdateWindow = Window | null;
|
|
387
|
+
/**
|
|
388
|
+
* `HH:MM-HH:MM`: the minutes of a day from `start` up to `end`, past midnight when `end` comes first.
|
|
389
|
+
*
|
|
390
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
391
|
+
* via the `definition` "Window".
|
|
392
|
+
*/
|
|
393
|
+
export type Window = string;
|
|
394
|
+
/**
|
|
395
|
+
* Whether the tracker webhook routes also answer requests forwarded for the public host name.
|
|
396
|
+
*/
|
|
397
|
+
export type PublicWebhooks1 = boolean;
|
|
398
|
+
/**
|
|
399
|
+
* The public name a reverse proxy forwards to `/hooks/`, such as `edgar.example.com`.
|
|
400
|
+
*/
|
|
401
|
+
export type PublicWebhookHost = string;
|
|
402
|
+
/**
|
|
403
|
+
* At most `limit` runs of this workflow at once for each value of `key` in the run's input; the next one waits.
|
|
404
|
+
*/
|
|
405
|
+
export type RunsAtOncePerKey = KeyedConcurrency | null;
|
|
406
|
+
/**
|
|
407
|
+
* A path into the run's input, `trigger.` then a field, or a list of them where the first with a value is the key.
|
|
408
|
+
*
|
|
409
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
410
|
+
* via the `definition` "TriggerPath".
|
|
411
|
+
*/
|
|
412
|
+
export type TriggerPath = string | [string, ...string[]];
|
|
413
|
+
/**
|
|
414
|
+
* The role this agent stage runs as, in place of its own.
|
|
415
|
+
*/
|
|
416
|
+
export type Role = string | null;
|
|
417
|
+
/**
|
|
418
|
+
* How hard this agent stage thinks: `low`, `medium`, `high` or `max`, in place of its role's.
|
|
419
|
+
*/
|
|
420
|
+
export type Effort2 = Effort1 | null;
|
|
421
|
+
/**
|
|
422
|
+
* An attempt of this stage that uses more tokens than this ends.
|
|
423
|
+
*/
|
|
424
|
+
export type TokenBudget = number | null;
|
|
425
|
+
/**
|
|
426
|
+
* The provider this agent stage runs on, such as `claude` or `codex`, in place of its role's.
|
|
427
|
+
*/
|
|
428
|
+
export type Provider1 = string | null;
|
|
429
|
+
/**
|
|
430
|
+
* Hosts this stage's commands may reach, added to the stage's own.
|
|
431
|
+
*/
|
|
432
|
+
export type AddedHosts = string[];
|
|
433
|
+
/**
|
|
434
|
+
* Whether the wait between attempts stays the same (`fixed`) or doubles (`exponential`).
|
|
435
|
+
*/
|
|
436
|
+
export type WaitBetweenAttempts = Backoff | null;
|
|
437
|
+
/**
|
|
438
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
439
|
+
* via the `definition` "Backoff".
|
|
440
|
+
*/
|
|
441
|
+
export type Backoff = "fixed" | "exponential";
|
|
442
|
+
/**
|
|
443
|
+
* The seconds before the second attempt.
|
|
444
|
+
*/
|
|
445
|
+
export type SecondsBetweenAttempts = number | null;
|
|
446
|
+
/**
|
|
447
|
+
* How many times this stage may run in all, the first time included.
|
|
448
|
+
*/
|
|
449
|
+
export type Attempts = number | null;
|
|
450
|
+
/**
|
|
451
|
+
* An attempt of this agent stage that sends nothing for this many seconds ends as silent.
|
|
452
|
+
*/
|
|
453
|
+
export type SilenceLimit = number | null;
|
|
454
|
+
/**
|
|
455
|
+
* The most seconds one attempt of this stage may take, in place of the stage's own.
|
|
456
|
+
*/
|
|
457
|
+
export type TimeLimit1 = number | null;
|
|
458
|
+
/**
|
|
459
|
+
* A bucket name both vendors accept: 3 to 63 of `a-z`, `0-9`, `-`, `.` and `_`, starting and ending with a letter or digit.
|
|
460
|
+
*
|
|
461
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
462
|
+
* via the `definition` "BucketName".
|
|
463
|
+
*/
|
|
464
|
+
export type BucketName = string;
|
|
465
|
+
/**
|
|
466
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
467
|
+
* via the `definition` "HookTimeout".
|
|
468
|
+
*/
|
|
469
|
+
export type HookTimeout = "pass" | "deny";
|
|
470
|
+
/**
|
|
471
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
472
|
+
* via the `definition` "LogFormat".
|
|
473
|
+
*/
|
|
474
|
+
export type LogFormat1 = "text" | "json";
|
|
475
|
+
/**
|
|
476
|
+
* `[tracker] outside`.
|
|
477
|
+
*
|
|
478
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
479
|
+
* via the `definition` "Outside".
|
|
480
|
+
*/
|
|
481
|
+
export type Outside = "answers" | "nothing";
|
|
482
|
+
/**
|
|
483
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
484
|
+
* via the `definition` "SandboxKind".
|
|
485
|
+
*/
|
|
486
|
+
export type SandboxKind1 = "worktree" | "container" | "none";
|
|
487
|
+
/**
|
|
488
|
+
* The cloud vendors whose object storage `[storage]` names.
|
|
489
|
+
*
|
|
490
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
491
|
+
* via the `definition` "StorageProvider".
|
|
492
|
+
*/
|
|
493
|
+
export type StorageProvider = "google" | "amazon";
|
|
494
|
+
|
|
495
|
+
export interface Config {
|
|
496
|
+
agents?: {
|
|
497
|
+
[k: string]: RoleSettings;
|
|
498
|
+
};
|
|
499
|
+
alerts?: Alerts;
|
|
500
|
+
api?: Api;
|
|
501
|
+
approval?: Approval;
|
|
502
|
+
concurrency?: Concurrency;
|
|
503
|
+
console?: Console;
|
|
504
|
+
daemon?: Daemon;
|
|
505
|
+
defaults?: Defaults;
|
|
506
|
+
extensions?: Extensions;
|
|
507
|
+
hooks?: Hooks;
|
|
508
|
+
limits?: Limits;
|
|
509
|
+
logs?: Logs;
|
|
510
|
+
mcp?: Mcp;
|
|
511
|
+
outbox?: {
|
|
512
|
+
[k: string]: OutboxChannel;
|
|
513
|
+
};
|
|
514
|
+
people?: {
|
|
515
|
+
[k: string]: Person;
|
|
516
|
+
};
|
|
517
|
+
project: ProjectSettings;
|
|
518
|
+
providers?: {
|
|
519
|
+
acp?: ProviderSettings;
|
|
520
|
+
claude?: ProviderSettings;
|
|
521
|
+
codex?: ProviderSettings;
|
|
522
|
+
};
|
|
523
|
+
roles?: Roles;
|
|
524
|
+
runtime?: Runtime;
|
|
525
|
+
sandbox?: Sandbox;
|
|
526
|
+
screenshots?: Screenshots;
|
|
527
|
+
secrets?: Secrets;
|
|
528
|
+
services?: {
|
|
529
|
+
[k: string]: Service;
|
|
530
|
+
};
|
|
531
|
+
/**
|
|
532
|
+
* With no table, every backup stays on the machine.
|
|
533
|
+
*/
|
|
534
|
+
storage?: StorageSettings | null;
|
|
535
|
+
store?: Store;
|
|
536
|
+
tools?: Tools;
|
|
537
|
+
tracker?: Tracker;
|
|
538
|
+
update?: Update;
|
|
539
|
+
webhooks?: Webhooks;
|
|
540
|
+
workflows?: {
|
|
541
|
+
[k: string]: WorkflowSettings;
|
|
542
|
+
};
|
|
543
|
+
}
|
|
544
|
+
/**
|
|
545
|
+
* `[agents.<role>]`: `disabled = true` removes a role of a lower layer; `model`, `effort`, `fallback` and `steer` replace the role's own, so a project changes them with no copy of the role's folder.
|
|
546
|
+
*
|
|
547
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
548
|
+
* via the `definition` "RoleSettings".
|
|
549
|
+
*/
|
|
550
|
+
export interface RoleSettings {
|
|
551
|
+
disabled?: TurnedOff;
|
|
552
|
+
effort?: Effort;
|
|
553
|
+
fallback?: FallbackProviders;
|
|
554
|
+
model?: Provider;
|
|
555
|
+
steer?: SteerFromComments;
|
|
556
|
+
}
|
|
557
|
+
/**
|
|
558
|
+
* `[alerts]`: EDGAR's own alerts that work as designed, such as a command the sandbox blocks on purpose. An alert that holds one of `expected` stays in the events and the console, and gets no card on the service `edgar`. Empty by default, so nothing is hidden that the project does not name.
|
|
559
|
+
*/
|
|
560
|
+
export interface Alerts {
|
|
561
|
+
expected?: ExpectedAlerts;
|
|
562
|
+
}
|
|
563
|
+
/**
|
|
564
|
+
* `[api]`; no `bind` means loopback.
|
|
565
|
+
*/
|
|
566
|
+
export interface Api {
|
|
567
|
+
bind?: APIAddress;
|
|
568
|
+
identity?: IdentityExtension;
|
|
569
|
+
public_url?: PublicURL;
|
|
570
|
+
}
|
|
571
|
+
/**
|
|
572
|
+
* The extension that `[api] identity` names.
|
|
573
|
+
*
|
|
574
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
575
|
+
* via the `definition` "IdentityExtension".
|
|
576
|
+
*/
|
|
577
|
+
export interface IdentityExtension1 {
|
|
578
|
+
extension: string;
|
|
579
|
+
}
|
|
580
|
+
/**
|
|
581
|
+
* When each tool waits for a person: `never`, `auto`, `once` or `always`, only stricter than its extension's own.
|
|
582
|
+
*/
|
|
583
|
+
export interface Approval {
|
|
584
|
+
[k: string]: ApprovalPolicy;
|
|
585
|
+
}
|
|
586
|
+
/**
|
|
587
|
+
* `[concurrency]`; unset values follow the machine.
|
|
588
|
+
*/
|
|
589
|
+
export interface Concurrency {
|
|
590
|
+
sandboxes?: SandboxesAtOnce;
|
|
591
|
+
slots?: StagesAtOnce;
|
|
592
|
+
}
|
|
593
|
+
/**
|
|
594
|
+
* `[console]`: where `edgar console` serves the console with the API beside it, and how many questions the console's Ask panel may put to stage sessions each minute.
|
|
595
|
+
*/
|
|
596
|
+
export interface Console {
|
|
597
|
+
ask_per_minute?: QuestionsPerMinute;
|
|
598
|
+
bind?: ConsoleAddress;
|
|
599
|
+
}
|
|
600
|
+
/**
|
|
601
|
+
* `[daemon]`: `enabled = true` makes `edgar start` detach as `edgar start --daemon` does.
|
|
602
|
+
*/
|
|
603
|
+
export interface Daemon {
|
|
604
|
+
enabled?: RunInTheBackground;
|
|
605
|
+
}
|
|
606
|
+
/**
|
|
607
|
+
* `[defaults.<kind>]`; a missing bound takes the kind's built-in value. A `workflow` stage has no bound of its own, so it has no table.
|
|
608
|
+
*/
|
|
609
|
+
export interface Defaults {
|
|
610
|
+
agent?: AgentDefaults;
|
|
611
|
+
check?: KindDefaults;
|
|
612
|
+
tool?: KindDefaults1;
|
|
613
|
+
wait?: KindDefaults2;
|
|
614
|
+
}
|
|
615
|
+
export interface AgentDefaults {
|
|
616
|
+
max_tokens?: AgentTokenBudget;
|
|
617
|
+
silence_seconds?: AgentSilenceLimit;
|
|
618
|
+
timeout_seconds?: AgentTimeLimit;
|
|
619
|
+
}
|
|
620
|
+
export interface KindDefaults {
|
|
621
|
+
timeout_seconds?: TimeLimit;
|
|
622
|
+
}
|
|
623
|
+
export interface KindDefaults1 {
|
|
624
|
+
timeout_seconds?: TimeLimit;
|
|
625
|
+
}
|
|
626
|
+
export interface KindDefaults2 {
|
|
627
|
+
timeout_seconds?: TimeLimit;
|
|
628
|
+
}
|
|
629
|
+
export interface Extensions {
|
|
630
|
+
enabled?: EnabledExtensions;
|
|
631
|
+
/**
|
|
632
|
+
* One extension's settings, checked against its manifest's `config_schema`.
|
|
633
|
+
*/
|
|
634
|
+
[k: string]:
|
|
635
|
+
| {
|
|
636
|
+
hosts?: ExtraHosts;
|
|
637
|
+
[k: string]: unknown;
|
|
638
|
+
}
|
|
639
|
+
| EnabledExtensions
|
|
640
|
+
| undefined;
|
|
641
|
+
}
|
|
642
|
+
/**
|
|
643
|
+
* `[hooks]`.
|
|
644
|
+
*/
|
|
645
|
+
export interface Hooks {
|
|
646
|
+
on_timeout?: WhenAHookDoesNotAnswer;
|
|
647
|
+
order?: HookOrder;
|
|
648
|
+
}
|
|
649
|
+
/**
|
|
650
|
+
* `[limits]`.
|
|
651
|
+
*/
|
|
652
|
+
export interface Limits {
|
|
653
|
+
card_runs_per_day?: RunsPerCardPerDay;
|
|
654
|
+
comment_bytes?: LongestCommentBytes;
|
|
655
|
+
pull_requests?: PullRequestCap | null;
|
|
656
|
+
questions_per_day?: QuestionsPerTrackerPerDay;
|
|
657
|
+
run_usd?: BudgetPerRunUSD;
|
|
658
|
+
self_merge_files?: FilesInASelfMerge;
|
|
659
|
+
}
|
|
660
|
+
/**
|
|
661
|
+
* `pull_requests = { per_hour = 10, per_day = 40 }`: past a cap, a call of `tool` waits for a person instead of opening another change. A missing cap does not count.
|
|
662
|
+
*
|
|
663
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
664
|
+
* via the `definition` "PullRequestCap".
|
|
665
|
+
*/
|
|
666
|
+
export interface PullRequestCap {
|
|
667
|
+
per_day?: PullRequestsPerDay;
|
|
668
|
+
per_hour?: PullRequestsPerHour;
|
|
669
|
+
tool?: ToolThatOpensAChange;
|
|
670
|
+
}
|
|
671
|
+
/**
|
|
672
|
+
* `[logs]`: how `edgar` writes its log to stderr; `EDGAR_LOG` picks which spans and events.
|
|
673
|
+
*/
|
|
674
|
+
export interface Logs {
|
|
675
|
+
format?: LogFormat;
|
|
676
|
+
keep?: RotatedLogsKept;
|
|
677
|
+
max_bytes?: LogSizeBeforeRotation;
|
|
678
|
+
}
|
|
679
|
+
/**
|
|
680
|
+
* `[mcp]`: `/mcp` answers a loopback `Host` only, unless `[mcp.remote]` is enabled.
|
|
681
|
+
*/
|
|
682
|
+
export interface Mcp {
|
|
683
|
+
remote?: RemoteMcp | null;
|
|
684
|
+
}
|
|
685
|
+
/**
|
|
686
|
+
* `[mcp.remote]`: with `enabled`, `/mcp` also answers a `Host` that `host` names, the name a reverse proxy forwards, and only with a personal token from `edgar token new`.
|
|
687
|
+
*
|
|
688
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
689
|
+
* via the `definition` "RemoteMcp".
|
|
690
|
+
*/
|
|
691
|
+
export interface RemoteMcp {
|
|
692
|
+
enabled?: RemoteMCP;
|
|
693
|
+
host: RemoteMCPHost;
|
|
694
|
+
}
|
|
695
|
+
/**
|
|
696
|
+
* `[outbox.<channel>]`.
|
|
697
|
+
*
|
|
698
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
699
|
+
* via the `definition` "OutboxChannel".
|
|
700
|
+
*/
|
|
701
|
+
export interface OutboxChannel {
|
|
702
|
+
retry?: Retry;
|
|
703
|
+
}
|
|
704
|
+
/**
|
|
705
|
+
* How the outbox sends a write to this channel again after it fails.
|
|
706
|
+
*/
|
|
707
|
+
export interface Retry {
|
|
708
|
+
backoff?: "fixed" | "exponential";
|
|
709
|
+
interval_seconds?: number;
|
|
710
|
+
max_attempts?: number;
|
|
711
|
+
}
|
|
712
|
+
/**
|
|
713
|
+
* `[people.<name>]`: a person who works with EDGAR, with their id in each extension, keyed by the extension's name. The name signs the moves of `edgar console --as <name>`.
|
|
714
|
+
*
|
|
715
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
716
|
+
* via the `definition` "Person".
|
|
717
|
+
*/
|
|
718
|
+
export interface Person {
|
|
719
|
+
email?: Email;
|
|
720
|
+
ids?: Ids;
|
|
721
|
+
}
|
|
722
|
+
/**
|
|
723
|
+
* The person's id in each extension, keyed by the extension's name: an id only their own account can change, such as an email or a login, never a display name; an id names one person.
|
|
724
|
+
*/
|
|
725
|
+
export interface Ids {
|
|
726
|
+
[k: string]: string;
|
|
727
|
+
}
|
|
728
|
+
/**
|
|
729
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
730
|
+
* via the `definition` "ProjectSettings".
|
|
731
|
+
*/
|
|
732
|
+
export interface ProjectSettings {
|
|
733
|
+
dry_run?: DryRun;
|
|
734
|
+
name: ProjectName;
|
|
735
|
+
}
|
|
736
|
+
/**
|
|
737
|
+
* One `[providers.<name>]` table.
|
|
738
|
+
*
|
|
739
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
740
|
+
* via the `definition` "ProviderSettings".
|
|
741
|
+
*/
|
|
742
|
+
export interface ProviderSettings {
|
|
743
|
+
command?: AgentCommand;
|
|
744
|
+
env_key?: KeyVariable;
|
|
745
|
+
model?: Model;
|
|
746
|
+
prices?: Prices;
|
|
747
|
+
}
|
|
748
|
+
/**
|
|
749
|
+
* USD per million tokens. Cached tokens with no `cached` price cost the input price.
|
|
750
|
+
*
|
|
751
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
752
|
+
* via the `definition` "Prices".
|
|
753
|
+
*/
|
|
754
|
+
export interface Prices1 {
|
|
755
|
+
cache_write?: number | null;
|
|
756
|
+
cached?: number | null;
|
|
757
|
+
input: number;
|
|
758
|
+
output: number;
|
|
759
|
+
}
|
|
760
|
+
/**
|
|
761
|
+
* `[roles]`; an empty `operator` list means everyone on the box.
|
|
762
|
+
*/
|
|
763
|
+
export interface Roles {
|
|
764
|
+
operator?: Operators;
|
|
765
|
+
}
|
|
766
|
+
/**
|
|
767
|
+
* `[runtime]`.
|
|
768
|
+
*/
|
|
769
|
+
export interface Runtime {
|
|
770
|
+
idle_seconds?: IdleSecondsBeforeARuntimeExits;
|
|
771
|
+
}
|
|
772
|
+
/**
|
|
773
|
+
* `[sandbox]`.
|
|
774
|
+
*/
|
|
775
|
+
export interface Sandbox {
|
|
776
|
+
deny?: RefusedCommands;
|
|
777
|
+
git_tokens?: GitTokens;
|
|
778
|
+
image?: ContainerImage;
|
|
779
|
+
keep_while_waiting_hours?: HoursAWaitingRunKeepsItsSandbox;
|
|
780
|
+
kind?: SandboxKind;
|
|
781
|
+
max_behind?: CommitsBehindBeforeWorkRestarts;
|
|
782
|
+
min_free_gb?: FreeDiskNeededGB;
|
|
783
|
+
network?: HostsEveryCommandReaches;
|
|
784
|
+
secret_files?: SecretFiles;
|
|
785
|
+
signed_commits?: SignedCommits;
|
|
786
|
+
}
|
|
787
|
+
/**
|
|
788
|
+
* For each `https://` host, the token that EDGAR's own git sends there.
|
|
789
|
+
*/
|
|
790
|
+
export interface GitTokens {
|
|
791
|
+
[k: string]: GitToken;
|
|
792
|
+
}
|
|
793
|
+
/**
|
|
794
|
+
* For each `https://` host, the extension that publishes EDGAR's pushes there as commits the host signs, in place of `git push`.
|
|
795
|
+
*/
|
|
796
|
+
export interface SignedCommits {
|
|
797
|
+
[k: string]: string;
|
|
798
|
+
}
|
|
799
|
+
/**
|
|
800
|
+
* `[screenshots]`: where the pictures of pull requests are kept, when `[storage]` and `[api] public_url` are set.
|
|
801
|
+
*/
|
|
802
|
+
export interface Screenshots {
|
|
803
|
+
legacy?: EarlierPictures;
|
|
804
|
+
}
|
|
805
|
+
/**
|
|
806
|
+
* Where each secret comes from; only the names and the kind of source are shown.
|
|
807
|
+
*/
|
|
808
|
+
export interface Secrets {
|
|
809
|
+
[k: string]: SecretSource;
|
|
810
|
+
}
|
|
811
|
+
/**
|
|
812
|
+
* `[services.<name>]`.
|
|
813
|
+
*
|
|
814
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
815
|
+
* via the `definition` "Service".
|
|
816
|
+
*/
|
|
817
|
+
export interface Service {
|
|
818
|
+
checks?: {
|
|
819
|
+
[k: string]: Check;
|
|
820
|
+
};
|
|
821
|
+
default_branch: DefaultBranch;
|
|
822
|
+
env?: Variables;
|
|
823
|
+
environment?: RunningStack;
|
|
824
|
+
path_notices?: PathNotices;
|
|
825
|
+
prepare?: PreparedDependencies;
|
|
826
|
+
repo: Repository;
|
|
827
|
+
}
|
|
828
|
+
/**
|
|
829
|
+
* A check command as structured arguments, never a shell string.
|
|
830
|
+
*
|
|
831
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
832
|
+
* via the `definition` "Check".
|
|
833
|
+
*/
|
|
834
|
+
export interface Check {
|
|
835
|
+
cmd: CheckCommand;
|
|
836
|
+
timeout_seconds?: CheckTimeLimit;
|
|
837
|
+
}
|
|
838
|
+
/**
|
|
839
|
+
* Variables every command in this service's sandbox gets; never a credential.
|
|
840
|
+
*/
|
|
841
|
+
export interface Variables {
|
|
842
|
+
[k: string]: string;
|
|
843
|
+
}
|
|
844
|
+
/**
|
|
845
|
+
* A service's running stack, run by an extension's environment provider.
|
|
846
|
+
*
|
|
847
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
848
|
+
* via the `definition` "Environment".
|
|
849
|
+
*/
|
|
850
|
+
export interface Environment {
|
|
851
|
+
provider: string;
|
|
852
|
+
}
|
|
853
|
+
/**
|
|
854
|
+
* `[[services.<name>.path_notices]]`.
|
|
855
|
+
*
|
|
856
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
857
|
+
* via the `definition` "PathNotice".
|
|
858
|
+
*/
|
|
859
|
+
export interface PathNotice {
|
|
860
|
+
notice: string;
|
|
861
|
+
prefix: string;
|
|
862
|
+
}
|
|
863
|
+
/**
|
|
864
|
+
* `[services.<name>] prepare`: `cmd` runs once in a new sandbox for each content of the files in `inputs`; what it adds to the work folder becomes the service's prepared layer, which each later sandbox with the same inputs gets a copy of.
|
|
865
|
+
*
|
|
866
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
867
|
+
* via the `definition` "Prepare".
|
|
868
|
+
*/
|
|
869
|
+
export interface Prepare {
|
|
870
|
+
/**
|
|
871
|
+
* The program and its arguments, never a shell string, such as `["pnpm", "install", "--frozen-lockfile"]`.
|
|
872
|
+
*/
|
|
873
|
+
cmd: string[];
|
|
874
|
+
/**
|
|
875
|
+
* The files, relative to the repository, whose content names the layer, such as `["pnpm-lock.yaml"]`.
|
|
876
|
+
*/
|
|
877
|
+
inputs: string[];
|
|
878
|
+
/**
|
|
879
|
+
* Whether the packages' install scripts run; off unless set.
|
|
880
|
+
*/
|
|
881
|
+
scripts?: boolean;
|
|
882
|
+
}
|
|
883
|
+
/**
|
|
884
|
+
* `[storage]`: the bucket that holds EDGAR's state off the machine. Credentials are never here: the machine's own identity, or a key that `[secrets]` names.
|
|
885
|
+
*
|
|
886
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
887
|
+
* via the `definition` "StorageSettings".
|
|
888
|
+
*/
|
|
889
|
+
export interface StorageSettings {
|
|
890
|
+
bucket: Bucket;
|
|
891
|
+
endpoint?: StorageAddress;
|
|
892
|
+
prefix?: FolderInTheBucket;
|
|
893
|
+
provider: CloudVendor;
|
|
894
|
+
region?: Region;
|
|
895
|
+
}
|
|
896
|
+
/**
|
|
897
|
+
* `[store]`; `retention_days = 0` keeps every payload.
|
|
898
|
+
*/
|
|
899
|
+
export interface Store {
|
|
900
|
+
backup_command?: CommandAfterEachBackup;
|
|
901
|
+
backup_minutes?: MinutesBetweenBackups;
|
|
902
|
+
retention_days?: DaysKept;
|
|
903
|
+
}
|
|
904
|
+
/**
|
|
905
|
+
* `[tools] disabled` removes a tool; `enabled` turns on one its manifest ships off.
|
|
906
|
+
*/
|
|
907
|
+
export interface Tools {
|
|
908
|
+
disabled?: TurnedOffTools;
|
|
909
|
+
enabled?: TurnedOnTools;
|
|
910
|
+
}
|
|
911
|
+
/**
|
|
912
|
+
* `[tracker]`. `attachment_hosts` empty: only the host of the card's own url.
|
|
913
|
+
*/
|
|
914
|
+
export interface Tracker {
|
|
915
|
+
attachment_hosts?: AttachmentHosts;
|
|
916
|
+
default?: DefaultTracker;
|
|
917
|
+
default_service?: DefaultService;
|
|
918
|
+
mark_seen?: MarkCardsSeen;
|
|
919
|
+
outside?: OutsideTheTeam;
|
|
920
|
+
sweep_seconds?: SecondsBetweenTrackerReads;
|
|
921
|
+
}
|
|
922
|
+
/**
|
|
923
|
+
* `[update]`: whether the worker looks for a newer release of EDGAR, how often, and when and to which version it updates itself.
|
|
924
|
+
*/
|
|
925
|
+
export interface Update {
|
|
926
|
+
check_minutes?: MinutesBetweenUpdateChecks;
|
|
927
|
+
enabled?: SelfUpdate;
|
|
928
|
+
time_zone?: TimeZone;
|
|
929
|
+
version?: VersionToHold;
|
|
930
|
+
window?: UpdateWindow;
|
|
931
|
+
}
|
|
932
|
+
/**
|
|
933
|
+
* `[webhooks]`: `/hooks/<extension>/<route>` answers a loopback `Host` only, unless `[webhooks.public]` is enabled.
|
|
934
|
+
*/
|
|
935
|
+
export interface Webhooks {
|
|
936
|
+
public?: PublicWebhooks | null;
|
|
937
|
+
}
|
|
938
|
+
/**
|
|
939
|
+
* `[webhooks.public]`: with `enabled`, the tracker webhook routes also answer a `Host` that `host` names, the name a reverse proxy forwards; each delivery still needs its signature.
|
|
940
|
+
*
|
|
941
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
942
|
+
* via the `definition` "PublicWebhooks".
|
|
943
|
+
*/
|
|
944
|
+
export interface PublicWebhooks {
|
|
945
|
+
enabled?: PublicWebhooks1;
|
|
946
|
+
host: PublicWebhookHost;
|
|
947
|
+
}
|
|
948
|
+
/**
|
|
949
|
+
* `[workflows.<name>]`: the settings of one workflow that its file does not hold.
|
|
950
|
+
*
|
|
951
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
952
|
+
* via the `definition` "WorkflowSettings".
|
|
953
|
+
*/
|
|
954
|
+
export interface WorkflowSettings {
|
|
955
|
+
concurrency?: RunsAtOncePerKey;
|
|
956
|
+
/**
|
|
957
|
+
* The keys of one stage this project changes, by the stage's name, on top of the stage every layer gives, so the stage is never copied.
|
|
958
|
+
*/
|
|
959
|
+
stages?: {
|
|
960
|
+
[k: string]: StageOverride;
|
|
961
|
+
};
|
|
962
|
+
}
|
|
963
|
+
/**
|
|
964
|
+
* `concurrency = { key = "trigger.<field>", limit = n }`: at most `limit` runs of the workflow hold a start at once for each value the key reads from the run's input; the next one stays `queued`. A run whose input has no value at `key` counts under the value `null`.
|
|
965
|
+
*
|
|
966
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
967
|
+
* via the `definition` "KeyedConcurrency".
|
|
968
|
+
*/
|
|
969
|
+
export interface KeyedConcurrency {
|
|
970
|
+
key: TriggerPath;
|
|
971
|
+
limit: number;
|
|
972
|
+
}
|
|
973
|
+
/**
|
|
974
|
+
* `[workflows.<name>.stages.<stage>]`: each key it names replaces the stage's own after every layer merged, and each key it leaves out keeps the stage's own value. A stage of a project's workflow file replaces the lower stage whole; this table changes one key of it.
|
|
975
|
+
*
|
|
976
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
977
|
+
* via the `definition` "StageOverride".
|
|
978
|
+
*/
|
|
979
|
+
export interface StageOverride {
|
|
980
|
+
agent?: Role;
|
|
981
|
+
effort?: Effort2;
|
|
982
|
+
max_tokens?: TokenBudget;
|
|
983
|
+
model?: Provider1;
|
|
984
|
+
network?: AddedHosts;
|
|
985
|
+
retry?: RetryOverride;
|
|
986
|
+
silence_seconds?: SilenceLimit;
|
|
987
|
+
timeout_seconds?: TimeLimit1;
|
|
988
|
+
}
|
|
989
|
+
/**
|
|
990
|
+
* `retry = { ... }` of a stage override: each key it names replaces that key of the stage's retry policy, and the others keep the stage's own.
|
|
991
|
+
*/
|
|
992
|
+
export interface RetryOverride {
|
|
993
|
+
backoff?: WaitBetweenAttempts;
|
|
994
|
+
interval_seconds?: SecondsBetweenAttempts;
|
|
995
|
+
max_attempts?: Attempts;
|
|
996
|
+
}
|
|
997
|
+
/**
|
|
998
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
999
|
+
* via the `definition` "AgentDefaults".
|
|
1000
|
+
*/
|
|
1001
|
+
export interface AgentDefaults1 {
|
|
1002
|
+
max_tokens?: AgentTokenBudget;
|
|
1003
|
+
silence_seconds?: AgentSilenceLimit;
|
|
1004
|
+
timeout_seconds?: AgentTimeLimit;
|
|
1005
|
+
}
|
|
1006
|
+
/**
|
|
1007
|
+
* `[alerts]`: EDGAR's own alerts that work as designed, such as a command the sandbox blocks on purpose. An alert that holds one of `expected` stays in the events and the console, and gets no card on the service `edgar`. Empty by default, so nothing is hidden that the project does not name.
|
|
1008
|
+
*
|
|
1009
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1010
|
+
* via the `definition` "Alerts".
|
|
1011
|
+
*/
|
|
1012
|
+
export interface Alerts1 {
|
|
1013
|
+
expected?: ExpectedAlerts;
|
|
1014
|
+
}
|
|
1015
|
+
/**
|
|
1016
|
+
* `[api]`; no `bind` means loopback.
|
|
1017
|
+
*
|
|
1018
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1019
|
+
* via the `definition` "Api".
|
|
1020
|
+
*/
|
|
1021
|
+
export interface Api1 {
|
|
1022
|
+
bind?: APIAddress;
|
|
1023
|
+
identity?: IdentityExtension;
|
|
1024
|
+
public_url?: PublicURL;
|
|
1025
|
+
}
|
|
1026
|
+
/**
|
|
1027
|
+
* `[concurrency]`; unset values follow the machine.
|
|
1028
|
+
*
|
|
1029
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1030
|
+
* via the `definition` "Concurrency".
|
|
1031
|
+
*/
|
|
1032
|
+
export interface Concurrency1 {
|
|
1033
|
+
sandboxes?: SandboxesAtOnce;
|
|
1034
|
+
slots?: StagesAtOnce;
|
|
1035
|
+
}
|
|
1036
|
+
/**
|
|
1037
|
+
* `[console]`: where `edgar console` serves the console with the API beside it, and how many questions the console's Ask panel may put to stage sessions each minute.
|
|
1038
|
+
*
|
|
1039
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1040
|
+
* via the `definition` "Console".
|
|
1041
|
+
*/
|
|
1042
|
+
export interface Console1 {
|
|
1043
|
+
ask_per_minute?: QuestionsPerMinute;
|
|
1044
|
+
bind?: ConsoleAddress;
|
|
1045
|
+
}
|
|
1046
|
+
/**
|
|
1047
|
+
* `[daemon]`: `enabled = true` makes `edgar start` detach as `edgar start --daemon` does.
|
|
1048
|
+
*
|
|
1049
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1050
|
+
* via the `definition` "Daemon".
|
|
1051
|
+
*/
|
|
1052
|
+
export interface Daemon1 {
|
|
1053
|
+
enabled?: RunInTheBackground;
|
|
1054
|
+
}
|
|
1055
|
+
/**
|
|
1056
|
+
* `[defaults.<kind>]`; a missing bound takes the kind's built-in value. A `workflow` stage has no bound of its own, so it has no table.
|
|
1057
|
+
*
|
|
1058
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1059
|
+
* via the `definition` "Defaults".
|
|
1060
|
+
*/
|
|
1061
|
+
export interface Defaults1 {
|
|
1062
|
+
agent?: AgentDefaults;
|
|
1063
|
+
check?: KindDefaults;
|
|
1064
|
+
tool?: KindDefaults1;
|
|
1065
|
+
wait?: KindDefaults2;
|
|
1066
|
+
}
|
|
1067
|
+
/**
|
|
1068
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1069
|
+
* via the `definition` "Extensions".
|
|
1070
|
+
*/
|
|
1071
|
+
export interface Extensions1 {
|
|
1072
|
+
enabled?: EnabledExtensions;
|
|
1073
|
+
/**
|
|
1074
|
+
* One extension's settings, checked against its manifest's `config_schema`.
|
|
1075
|
+
*/
|
|
1076
|
+
[k: string]:
|
|
1077
|
+
| {
|
|
1078
|
+
hosts?: ExtraHosts;
|
|
1079
|
+
[k: string]: unknown;
|
|
1080
|
+
}
|
|
1081
|
+
| EnabledExtensions
|
|
1082
|
+
| undefined;
|
|
1083
|
+
}
|
|
1084
|
+
/**
|
|
1085
|
+
* `[hooks]`.
|
|
1086
|
+
*
|
|
1087
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1088
|
+
* via the `definition` "Hooks".
|
|
1089
|
+
*/
|
|
1090
|
+
export interface Hooks1 {
|
|
1091
|
+
on_timeout?: WhenAHookDoesNotAnswer;
|
|
1092
|
+
order?: HookOrder;
|
|
1093
|
+
}
|
|
1094
|
+
/**
|
|
1095
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1096
|
+
* via the `definition` "KindDefaults".
|
|
1097
|
+
*/
|
|
1098
|
+
export interface KindDefaults3 {
|
|
1099
|
+
timeout_seconds?: TimeLimit;
|
|
1100
|
+
}
|
|
1101
|
+
/**
|
|
1102
|
+
* `[limits]`.
|
|
1103
|
+
*
|
|
1104
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1105
|
+
* via the `definition` "Limits".
|
|
1106
|
+
*/
|
|
1107
|
+
export interface Limits1 {
|
|
1108
|
+
card_runs_per_day?: RunsPerCardPerDay;
|
|
1109
|
+
comment_bytes?: LongestCommentBytes;
|
|
1110
|
+
pull_requests?: PullRequestCap | null;
|
|
1111
|
+
questions_per_day?: QuestionsPerTrackerPerDay;
|
|
1112
|
+
run_usd?: BudgetPerRunUSD;
|
|
1113
|
+
self_merge_files?: FilesInASelfMerge;
|
|
1114
|
+
}
|
|
1115
|
+
/**
|
|
1116
|
+
* `[logs]`: how `edgar` writes its log to stderr; `EDGAR_LOG` picks which spans and events.
|
|
1117
|
+
*
|
|
1118
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1119
|
+
* via the `definition` "Logs".
|
|
1120
|
+
*/
|
|
1121
|
+
export interface Logs1 {
|
|
1122
|
+
format?: LogFormat;
|
|
1123
|
+
keep?: RotatedLogsKept;
|
|
1124
|
+
max_bytes?: LogSizeBeforeRotation;
|
|
1125
|
+
}
|
|
1126
|
+
/**
|
|
1127
|
+
* `[mcp]`: `/mcp` answers a loopback `Host` only, unless `[mcp.remote]` is enabled.
|
|
1128
|
+
*
|
|
1129
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1130
|
+
* via the `definition` "Mcp".
|
|
1131
|
+
*/
|
|
1132
|
+
export interface Mcp1 {
|
|
1133
|
+
remote?: RemoteMcp | null;
|
|
1134
|
+
}
|
|
1135
|
+
/**
|
|
1136
|
+
* `retry = { ... }` of a stage override: each key it names replaces that key of the stage's retry policy, and the others keep the stage's own.
|
|
1137
|
+
*
|
|
1138
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1139
|
+
* via the `definition` "RetryOverride".
|
|
1140
|
+
*/
|
|
1141
|
+
export interface RetryOverride1 {
|
|
1142
|
+
backoff?: WaitBetweenAttempts;
|
|
1143
|
+
interval_seconds?: SecondsBetweenAttempts;
|
|
1144
|
+
max_attempts?: Attempts;
|
|
1145
|
+
}
|
|
1146
|
+
/**
|
|
1147
|
+
* `retry = { max_attempts, interval_seconds, backoff }`; the default is one attempt.
|
|
1148
|
+
*
|
|
1149
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1150
|
+
* via the `definition` "RetryPolicy".
|
|
1151
|
+
*/
|
|
1152
|
+
export interface RetryPolicy {
|
|
1153
|
+
backoff?: "fixed" | "exponential";
|
|
1154
|
+
interval_seconds?: number;
|
|
1155
|
+
max_attempts?: number;
|
|
1156
|
+
}
|
|
1157
|
+
/**
|
|
1158
|
+
* `[roles]`; an empty `operator` list means everyone on the box.
|
|
1159
|
+
*
|
|
1160
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1161
|
+
* via the `definition` "Roles".
|
|
1162
|
+
*/
|
|
1163
|
+
export interface Roles1 {
|
|
1164
|
+
operator?: Operators;
|
|
1165
|
+
}
|
|
1166
|
+
/**
|
|
1167
|
+
* `[runtime]`.
|
|
1168
|
+
*
|
|
1169
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1170
|
+
* via the `definition` "Runtime".
|
|
1171
|
+
*/
|
|
1172
|
+
export interface Runtime1 {
|
|
1173
|
+
idle_seconds?: IdleSecondsBeforeARuntimeExits;
|
|
1174
|
+
}
|
|
1175
|
+
/**
|
|
1176
|
+
* `[sandbox]`.
|
|
1177
|
+
*
|
|
1178
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1179
|
+
* via the `definition` "Sandbox".
|
|
1180
|
+
*/
|
|
1181
|
+
export interface Sandbox1 {
|
|
1182
|
+
deny?: RefusedCommands;
|
|
1183
|
+
git_tokens?: GitTokens;
|
|
1184
|
+
image?: ContainerImage;
|
|
1185
|
+
keep_while_waiting_hours?: HoursAWaitingRunKeepsItsSandbox;
|
|
1186
|
+
kind?: SandboxKind;
|
|
1187
|
+
max_behind?: CommitsBehindBeforeWorkRestarts;
|
|
1188
|
+
min_free_gb?: FreeDiskNeededGB;
|
|
1189
|
+
network?: HostsEveryCommandReaches;
|
|
1190
|
+
secret_files?: SecretFiles;
|
|
1191
|
+
signed_commits?: SignedCommits;
|
|
1192
|
+
}
|
|
1193
|
+
/**
|
|
1194
|
+
* `[screenshots]`: where the pictures of pull requests are kept, when `[storage]` and `[api] public_url` are set.
|
|
1195
|
+
*
|
|
1196
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1197
|
+
* via the `definition` "Screenshots".
|
|
1198
|
+
*/
|
|
1199
|
+
export interface Screenshots1 {
|
|
1200
|
+
legacy?: EarlierPictures;
|
|
1201
|
+
}
|
|
1202
|
+
/**
|
|
1203
|
+
* `[store]`; `retention_days = 0` keeps every payload.
|
|
1204
|
+
*
|
|
1205
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1206
|
+
* via the `definition` "Store".
|
|
1207
|
+
*/
|
|
1208
|
+
export interface Store1 {
|
|
1209
|
+
backup_command?: CommandAfterEachBackup;
|
|
1210
|
+
backup_minutes?: MinutesBetweenBackups;
|
|
1211
|
+
retention_days?: DaysKept;
|
|
1212
|
+
}
|
|
1213
|
+
/**
|
|
1214
|
+
* `[tools] disabled` removes a tool; `enabled` turns on one its manifest ships off.
|
|
1215
|
+
*
|
|
1216
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1217
|
+
* via the `definition` "Tools".
|
|
1218
|
+
*/
|
|
1219
|
+
export interface Tools1 {
|
|
1220
|
+
disabled?: TurnedOffTools;
|
|
1221
|
+
enabled?: TurnedOnTools;
|
|
1222
|
+
}
|
|
1223
|
+
/**
|
|
1224
|
+
* `[tracker]`. `attachment_hosts` empty: only the host of the card's own url.
|
|
1225
|
+
*
|
|
1226
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1227
|
+
* via the `definition` "Tracker".
|
|
1228
|
+
*/
|
|
1229
|
+
export interface Tracker1 {
|
|
1230
|
+
attachment_hosts?: AttachmentHosts;
|
|
1231
|
+
default?: DefaultTracker;
|
|
1232
|
+
default_service?: DefaultService;
|
|
1233
|
+
mark_seen?: MarkCardsSeen;
|
|
1234
|
+
outside?: OutsideTheTeam;
|
|
1235
|
+
sweep_seconds?: SecondsBetweenTrackerReads;
|
|
1236
|
+
}
|
|
1237
|
+
/**
|
|
1238
|
+
* `[update]`: whether the worker looks for a newer release of EDGAR, how often, and when and to which version it updates itself.
|
|
1239
|
+
*
|
|
1240
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1241
|
+
* via the `definition` "Update".
|
|
1242
|
+
*/
|
|
1243
|
+
export interface Update1 {
|
|
1244
|
+
check_minutes?: MinutesBetweenUpdateChecks;
|
|
1245
|
+
enabled?: SelfUpdate;
|
|
1246
|
+
time_zone?: TimeZone;
|
|
1247
|
+
version?: VersionToHold;
|
|
1248
|
+
window?: UpdateWindow;
|
|
1249
|
+
}
|
|
1250
|
+
/**
|
|
1251
|
+
* `[webhooks]`: `/hooks/<extension>/<route>` answers a loopback `Host` only, unless `[webhooks.public]` is enabled.
|
|
1252
|
+
*
|
|
1253
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1254
|
+
* via the `definition` "Webhooks".
|
|
1255
|
+
*/
|
|
1256
|
+
export interface Webhooks1 {
|
|
1257
|
+
public?: PublicWebhooks | null;
|
|
1258
|
+
}
|