@evolvingmachines/evolve 0.0.55-project-sable.20260916.db0bc0bb

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.
Files changed (98) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +25 -0
  3. package/dist/chunk-5GVMBEYI.js +11 -0
  4. package/dist/chunk-HQJI3HHU.js +1 -0
  5. package/dist/chunk-JS2UTK2I.js +427 -0
  6. package/dist/cli/index.cjs +73 -0
  7. package/dist/cli/index.d.cts +270 -0
  8. package/dist/cli/index.d.ts +270 -0
  9. package/dist/cli/index.js +54 -0
  10. package/dist/index.cjs +669 -0
  11. package/dist/index.d.cts +5023 -0
  12. package/dist/index.d.ts +5023 -0
  13. package/dist/index.js +230 -0
  14. package/dist/managed-modal-IJW62SSK.js +4 -0
  15. package/dist/resumable-HFSICSH3.js +1 -0
  16. package/dist/tar-GVC4KE52.js +1 -0
  17. package/dist/types-DlpTxdR_.d.cts +4777 -0
  18. package/dist/types-DlpTxdR_.d.ts +4777 -0
  19. package/dist/upload-KPYDMWFJ.js +1 -0
  20. package/docs-agents/SKILL.md +138 -0
  21. package/docs-agents/index.md +81 -0
  22. package/docs-agents/python/01-getting-started.md +511 -0
  23. package/docs-agents/python/02-configuration.md +855 -0
  24. package/docs-agents/python/03-runtime.md +899 -0
  25. package/docs-agents/python/04-streaming.md +451 -0
  26. package/docs-agents/python/05-swarm-pipeline.md +953 -0
  27. package/docs-agents/python/index.md +122 -0
  28. package/docs-agents/typescript/01-getting-started.md +494 -0
  29. package/docs-agents/typescript/02-configuration.md +841 -0
  30. package/docs-agents/typescript/03-runtime.md +864 -0
  31. package/docs-agents/typescript/04-streaming.md +478 -0
  32. package/docs-agents/typescript/05-swarm-pipeline.md +957 -0
  33. package/docs-agents/typescript/index.md +121 -0
  34. package/docs-evals/SKILL.md +112 -0
  35. package/docs-evals/cli-reference/agent.mdx +67 -0
  36. package/docs-evals/cli-reference/analysis.mdx +91 -0
  37. package/docs-evals/cli-reference/analyze.mdx +74 -0
  38. package/docs-evals/cli-reference/auth.mdx +60 -0
  39. package/docs-evals/cli-reference/check.mdx +146 -0
  40. package/docs-evals/cli-reference/dataset.mdx +133 -0
  41. package/docs-evals/cli-reference/index.mdx +108 -0
  42. package/docs-evals/cli-reference/job.mdx +239 -0
  43. package/docs-evals/cli-reference/run.mdx +196 -0
  44. package/docs-evals/cli-reference/secrets.mdx +95 -0
  45. package/docs-evals/cli-reference/skill.mdx +51 -0
  46. package/docs-evals/cli-reference/skills.mdx +81 -0
  47. package/docs-evals/cli-reference/trial.mdx +112 -0
  48. package/docs-evals/cli-reference/upload.mdx +36 -0
  49. package/docs-evals/core-concepts/agents.mdx +106 -0
  50. package/docs-evals/core-concepts/analyze.mdx +86 -0
  51. package/docs-evals/core-concepts/check.mdx +51 -0
  52. package/docs-evals/core-concepts/datasets.mdx +138 -0
  53. package/docs-evals/core-concepts/index.mdx +42 -0
  54. package/docs-evals/core-concepts/jobs.mdx +136 -0
  55. package/docs-evals/core-concepts/models.mdx +68 -0
  56. package/docs-evals/core-concepts/sandboxes.mdx +52 -0
  57. package/docs-evals/core-concepts/secrets.mdx +41 -0
  58. package/docs-evals/core-concepts/skills.mdx +42 -0
  59. package/docs-evals/core-concepts/tasks.mdx +216 -0
  60. package/docs-evals/core-concepts/trial-outputs.mdx +103 -0
  61. package/docs-evals/core-concepts/trials.mdx +103 -0
  62. package/docs-evals/core-concepts/upload.mdx +45 -0
  63. package/docs-evals/dashboard/checks.mdx +15 -0
  64. package/docs-evals/dashboard/datasets.mdx +24 -0
  65. package/docs-evals/dashboard/jobs.mdx +65 -0
  66. package/docs-evals/dashboard/traces.mdx +15 -0
  67. package/docs-evals/dashboard/trial-viewer.mdx +30 -0
  68. package/docs-evals/docs.json +180 -0
  69. package/docs-evals/getting-started/installation.mdx +56 -0
  70. package/docs-evals/getting-started/quick-start.mdx +85 -0
  71. package/docs-evals/index.mdx +36 -0
  72. package/docs-evals/sdk/python.mdx +139 -0
  73. package/docs-evals/sdk/typescript.mdx +141 -0
  74. package/docs-evals/sdk-reference/agents.mdx +105 -0
  75. package/docs-evals/sdk-reference/analyses.mdx +125 -0
  76. package/docs-evals/sdk-reference/auth.mdx +76 -0
  77. package/docs-evals/sdk-reference/checks.mdx +166 -0
  78. package/docs-evals/sdk-reference/datasets.mdx +305 -0
  79. package/docs-evals/sdk-reference/errors.mdx +199 -0
  80. package/docs-evals/sdk-reference/index.mdx +58 -0
  81. package/docs-evals/sdk-reference/jobs.mdx +731 -0
  82. package/docs-evals/sdk-reference/meta.mdx +52 -0
  83. package/docs-evals/sdk-reference/skills.mdx +68 -0
  84. package/docs-evals/sdk-reference/trials.mdx +232 -0
  85. package/docs-evals/sdk-reference/types.mdx +272 -0
  86. package/docs-evals/snippets/global-options.mdx +13 -0
  87. package/docs-evals/snippets/list-flags.mdx +23 -0
  88. package/harness-capabilities.json +430 -0
  89. package/hosted-error-codes.json +120 -0
  90. package/package.json +163 -0
  91. package/skills/create-adapter/SKILL.md +287 -0
  92. package/skills/create-task/SKILL.md +491 -0
  93. package/skills/evolve/SKILL.md +39 -0
  94. package/skills/publish/SKILL.md +142 -0
  95. package/skills/rewardkit/SKILL.md +330 -0
  96. package/spec/atif/README.md +45 -0
  97. package/spec/atif/trajectory.schema.json +865 -0
  98. package/spec/openapi.yaml +13447 -0
@@ -0,0 +1,121 @@
1
+ # Evolve TypeScript SDK
2
+
3
+ Run CLI agents in secure sandboxes with built-in observability.
4
+
5
+ ```bash
6
+ npm install @evolvingmachines/evolve
7
+ ```
8
+
9
+ ```ts
10
+ import { Evolve } from "@evolvingmachines/evolve";
11
+
12
+ const evolve = new Evolve();
13
+ await evolve.run({ prompt: "Hello world" });
14
+ ```
15
+
16
+ ---
17
+
18
+ ## Reference
19
+
20
+ ### Getting Started
21
+
22
+ | Topic | Link |
23
+ |-------|------|
24
+ | Installation (Node.js 18+, npm) | [Getting Started → Installation](./01-getting-started.md#installation) |
25
+ | Quick Start (3 steps) | [Getting Started → Quick Start](./01-getting-started.md#quick-start) |
26
+ | Core Lifecycle (run → getOutputFiles → kill) | [Getting Started → Core Lifecycle](./01-getting-started.md#core-lifecycle) |
27
+ | Streaming basics | [Getting Started → Streaming](./01-getting-started.md#streaming) |
28
+ | Gateway, managed BYO provider keys, and direct keys | [Getting Started → Authentication](./01-getting-started.md#authentication) |
29
+ | Gateway mode (EVOLVE_API_KEY) | [Getting Started → Gateway Mode](./01-getting-started.md#gateway-mode-evolve_api_key) |
30
+ | Managed BYO provider keys | [Getting Started → Managed BYO Provider Keys](./01-getting-started.md#managed-byo-provider-keys) |
31
+ | Managed secrets | [Configuration → Managed Secrets](./02-configuration.md#managed-secrets) |
32
+ | Direct provider key mode (local BYOK) | [Getting Started → Direct Provider Key Mode](./01-getting-started.md#direct-provider-key-mode-local-byok) |
33
+ | BYO Claude Max / Codex / Gemini subscription | [Getting Started → BYO Claude Max Subscription](./01-getting-started.md#byo-claude-max-subscription) |
34
+ | Supported agents & models | [Getting Started → Agent Reference](./01-getting-started.md#agent-reference) |
35
+ | Agent-specific options (reasoningEffort) | [Getting Started → Agent Reference](./01-getting-started.md#agent-reference) |
36
+
37
+ ### Configuration
38
+
39
+ | Topic | Link |
40
+ |-------|------|
41
+ | Sandbox providers (E2B, Modal, Daytona) | [Configuration → Sandbox Providers](./02-configuration.md#sandbox-providers) |
42
+ | Provider auto-resolution from env | [Configuration → Sandbox Providers](./02-configuration.md#auto-resolution) |
43
+ | `.withSandboxCreateOptions()` (image, network, user, homeDir) | [Configuration → Sandbox Create Options](./02-configuration.md#sandbox-create-options) |
44
+ | `.withWorkspaceMode()` (knowledge / swe) | [Configuration → Workspace Modes](./02-configuration.md#workspace-modes) |
45
+ | Evolve instance (full `.with*()` API) | [Configuration → Evolve Instance](./02-configuration.md#evolve-instance) |
46
+ | `.withAgent()` | [Configuration → Evolve Instance](./02-configuration.md#evolve-instance) |
47
+ | `.withSandbox()` | [Configuration → Sandbox Providers](./02-configuration.md#sandbox-providers) |
48
+ | `.withContext()` / `.withFiles()` | [Configuration → Evolve Instance](./02-configuration.md#evolve-instance) |
49
+ | `.withSystemPrompt()` | [Configuration → Evolve Instance](./02-configuration.md#evolve-instance) |
50
+ | `.withSchema()` (Zod / JSON Schema) | [Configuration → Evolve Instance](./02-configuration.md#evolve-instance) |
51
+ | `.withBrowser()` browser guide | [Configuration → Browser Automation](./02-configuration.md#browser-automation) |
52
+ | `.withBrowserCredentials()` browser logins | [Configuration → Browser Credentials](./02-configuration.md#browser-credentials) |
53
+ | `.withPlugins()` | [Configuration → Agent Plugins](./02-configuration.md#agent-plugins) |
54
+ | `.withSkills()` | [Configuration → Agent Skills](./02-configuration.md#agent-skills) |
55
+ | `.withIntegrations()` (managed app integrations) | [Configuration → Managed Integrations](./02-configuration.md#managed-integrations) |
56
+ | `.withManagedSecrets()` | [Configuration → Managed Secrets](./02-configuration.md#managed-secrets) |
57
+ | `.withMcpServers()` (STDIO / HTTP / SSE) | [Configuration → Evolve Instance](./02-configuration.md#evolve-instance) |
58
+ | `.withSecrets()` | [Configuration → Evolve Instance](./02-configuration.md#evolve-instance) |
59
+ | `.withStorage()` (checkpointing) | [Runtime → Storage & Checkpointing](./03-runtime.md#storage--checkpointing) |
60
+ | `.withSessionTagPrefix()` (observability) | [Runtime → Observability](./03-runtime.md#observability) |
61
+ | Skills catalog (PDF, browser, research, etc.) | [Configuration → Agent Skills](./02-configuration.md#agent-skills) |
62
+ | Integration auth/account helpers | [Configuration → Managed Integrations](./02-configuration.md#managed-integrations) |
63
+ | Integration tool filtering | [Configuration → Managed Integrations](./02-configuration.md#managed-integrations) |
64
+ | MCP server config (McpServerConfig) | [Configuration → Evolve Instance](./02-configuration.md#evolve-instance) |
65
+
66
+ ### Runtime
67
+
68
+ | Topic | Link |
69
+ |-------|------|
70
+ | `run()` | [Runtime → run](./03-runtime.md#run) |
71
+ | `executeCommand()` | [Runtime → executeCommand](./03-runtime.md#executecommand) |
72
+ | Streaming events (content, lifecycle, stdout, stderr) | [Streaming Events](./04-streaming.md) |
73
+ | OutputEvent / SessionUpdate types | [Streaming → SessionUpdate Types](./04-streaming.md#sessionupdate-types) |
74
+ | LifecycleEvent / LifecycleReason | [Streaming → LifecycleEvent](./04-streaming.md#lifecycleevent) |
75
+ | Tool events (ToolCall, ToolCallUpdate, ToolKind) | [Streaming → Tool Events](./04-streaming.md#tool-events) |
76
+ | Browser lifecycle event fields | [Streaming → Browser Automation Streaming](./04-streaming.md#browser-automation-streaming) |
77
+ | UI integration example | [Streaming → UI Integration Example](./04-streaming.md#ui-integration-example) |
78
+ | Upload files (`uploadContext()`, `uploadFiles()`) | [Runtime → Upload](./03-runtime.md#upload-local--sandbox) |
79
+ | Download files (`getOutputFiles()`, `saveLocalDir()`) | [Runtime → Download](./03-runtime.md#download-sandbox--local) |
80
+ | Session controls (interrupt, pause, resume, kill) | [Runtime → Session Controls](./03-runtime.md#session-controls) |
81
+ | `getHost()` (port forwarding) | [Runtime → getHost](./03-runtime.md#gethost) |
82
+ | Workspace filesystem layout | [Runtime → Workspace & Structured Output](./03-runtime.md#workspace--structured-output) |
83
+ | Structured output (Zod / JSON Schema) | [Runtime → Workspace & Structured Output](./03-runtime.md#structured-output) |
84
+ | Multi-turn conversations | [Runtime → Session Management](./03-runtime.md#session-management) |
85
+ | Pause / resume | [Runtime → Session Management](./03-runtime.md#session-management) |
86
+ | Save and reconnect (`withSession`, `setSession`) | [Runtime → Session Management](./03-runtime.md#session-management) |
87
+ | Storage & checkpointing (gateway) | [Runtime → Storage & Checkpointing](./03-runtime.md#storage--checkpointing) |
88
+ | Auto-checkpoint, explicit checkpoint, restore | [Runtime → Storage & Checkpointing](./03-runtime.md#auto-checkpoint-via-run) |
89
+ | Checkpoint lineage | [Runtime → Checkpoint Lineage](./03-runtime.md#checkpoint-lineage) |
90
+ | `storage()` client, `evolve.storage()` | [Runtime → Listing & Browsing Checkpoints](./03-runtime.md#listing--browsing-checkpoints) |
91
+ | `sessions()` client for past sessions & traces | [Runtime → Historical Sessions & Trace Download](./03-runtime.md#historical-sessions--trace-download) |
92
+ | Observability (dashboard + local logs) | [Runtime → Observability](./03-runtime.md#observability) |
93
+ | Error handling | [Runtime → Error Handling](./03-runtime.md#error-handling) |
94
+
95
+ ### Hosted evals
96
+
97
+ Datasets, jobs, trials, checks, analyses and the `evolve` CLI are documented at https://docs.evolvingmachines.ai. The `evolve-evals` skill carries the same pages.
98
+
99
+ ### Swarm & Pipeline
100
+
101
+ | Topic | Link |
102
+ |-------|------|
103
+ | Swarm setup (SwarmConfig) | [Swarm & Pipeline](./05-swarm-pipeline.md) |
104
+ | Input types (FileMap, folders, chaining) | [Swarm → Input Types](./05-swarm-pipeline.md#input-types) |
105
+ | `bestOf()` (N candidates + judge) | [Swarm → bestOf](./05-swarm-pipeline.md#bestof) |
106
+ | `map()` (parallel processing) | [Swarm → map](./05-swarm-pipeline.md#map) |
107
+ | `map()` + bestOf | [Swarm → map + bestOf](./05-swarm-pipeline.md#map--bestof) |
108
+ | `filter()` (evaluate + threshold) | [Swarm → filter](./05-swarm-pipeline.md#filter) |
109
+ | `reduce()` (synthesize many → one) | [Swarm → reduce](./05-swarm-pipeline.md#reduce) |
110
+ | `verify` (quality gate with feedback loop) | [Swarm → verify](./05-swarm-pipeline.md#verify-quality-gate) |
111
+ | Result types (SwarmResult, ReduceResult, BestOfResult) | [Swarm → Result Types](./05-swarm-pipeline.md#result-types) |
112
+ | Chaining operations (result.json → data.json) | [Swarm → Chaining Operations](./05-swarm-pipeline.md#chaining-operations) |
113
+ | AgentOverride (per-operation agent config) | [Swarm → AgentOverride](./05-swarm-pipeline.md#agentoverride) |
114
+ | Concurrency (semaphore, ordering guarantees) | [Swarm → Concurrency](./05-swarm-pipeline.md#concurrency) |
115
+ | RetryConfig (exponential backoff) | [Swarm & Pipeline](./05-swarm-pipeline.md) |
116
+ | Pipeline (fluent chaining) | [Swarm → Pipeline](./05-swarm-pipeline.md#pipeline) |
117
+ | Pipeline step configs (map, filter, reduce) | [Swarm → Step Configurations](./05-swarm-pipeline.md#step-configurations) |
118
+ | Pipeline events (stepStart, stepComplete, etc.) | [Swarm → Events](./05-swarm-pipeline.md#events) |
119
+ | Pipeline result (PipelineResult) | [Swarm → Result](./05-swarm-pipeline.md#result) |
120
+ | TerminalPipeline (reduce is terminal) | [Swarm → Terminal Pipeline](./05-swarm-pipeline.md#terminal-pipeline) |
121
+ | Filter `emit` option (success / filtered / all) | [Swarm → Pipeline](./05-swarm-pipeline.md#step-configurations) |
@@ -0,0 +1,112 @@
1
+ ---
2
+ # Generated by scripts/generate-skills.ts from docs-evals/docs.json. Do not edit; edit the source and run npm run generate:skills.
3
+ name: docs-evals
4
+ description: "Evolve hosted evals: run any model on any agent harness against datasets of Harbor-format tasks, in cloud sandboxes, from the evolve CLI and the TypeScript and Python SDKs. Use when the user wants to: (1) start, watch, or read a hosted eval job (evolve run, evolve job, jobs()), (2) browse the dataset catalog or publish their own dataset (evolve dataset), (3) check task quality (evolve check) or analyze trial traces (evolve analyze), (4) inspect or download trials, artifacts and traces (evolve trial, trials()), (5) register their own agent, mount skills, attach secrets, or choose models and sandbox providers, (6) upload a job run elsewhere (evolve upload), (7) use the dashboard's jobs, datasets, checks, traces and trial viewer pages. For running agents in sandboxes from code (the SDK's run(), Swarm, Pipeline) read `evolve skills get agents`."
5
+ metadata:
6
+ internal: true
7
+ ---
8
+
9
+ # Evolve hosted evals
10
+
11
+ Hosted evaluation for agents: datasets of Harbor-format tasks, jobs that run any model on any agent harness against them in cloud sandboxes, and the trials, checks and analyses they produce — from the `evolve` CLI and the TypeScript and Python SDKs.
12
+
13
+ This folder is the documentation site itself, page for page: every row below names a page by its site path, the file `<path>.mdx` beside this one, and `evolve skills get evals <path>` prints it. An `import` of `/snippets/<file>` is `snippets/<file>`.
14
+
15
+ ## How to use this skill
16
+
17
+ 1. Find the topic in the index below and read that page before writing any command or code: `evolve skills get evals <page>` prints it, the page named by its site path; `evolve skills get evals --full` prints every page.
18
+ 2. Every CLI verb is documented from its own `--help`; run `evolve <verb> --help` to confirm the flags of the installed version.
19
+ 3. Every command and every SDK client reads `EVOLVE_API_KEY`; the Installation page says where the key comes from.
20
+
21
+ ## Topic index
22
+
23
+ ## Docs
24
+
25
+ ### Getting started
26
+
27
+ | Page | What it covers |
28
+ | --- | --- |
29
+ | [Evolve documentation](/index) | Environment-driven agent evaluations: any model, any harness, any sandbox, one API key. Every task versioned and checked, every trajectory analyzed. |
30
+ | [Installation](/getting-started/installation) | Install the evolve command and the SDKs, and set your API key. |
31
+ | [Quick start](/getting-started/quick-start) | Start your first job, watch it run, and download a trial. |
32
+
33
+ ### Core concepts
34
+
35
+ | Page | What it covers |
36
+ | --- | --- |
37
+ | [Core concepts](/core-concepts/index) | How a dataset becomes trials, rewards, analyses and results. |
38
+ | [Tasks](/core-concepts/tasks) | The task format: one directory with an instruction, an environment, a verifier, and an optional reference solution. |
39
+ | [Datasets](/core-concepts/datasets) | The catalog, and publishing your own dataset. |
40
+ | [Jobs](/core-concepts/jobs) | Start a job, watch it, read its results, and derive new jobs from it. |
41
+ | [Trials](/core-concepts/trials) | One agent's attempt at one task: its record, its trace, and its artifacts. |
42
+ | [Trial outputs](/core-concepts/trial-outputs) | What a finished trial gives you, file by file, and in which formats. |
43
+ | [Agents](/core-concepts/agents) | The built-in harnesses, how to configure an arm, and how to register your own agent. |
44
+ | [Models](/core-concepts/models) | How a model is named on -m, and why one API key covers every provider. |
45
+ | [Sandboxes](/core-concepts/sandboxes) | Where trials run: e2b, daytona, or modal. |
46
+ | [Analyze](/core-concepts/analyze) | Judge every trial's trace against a rubric, on the platform. |
47
+ | [Check](/core-concepts/check) | Check the quality of tasks against a rubric before you spend a job on them. |
48
+ | [Skills](/core-concepts/skills) | Mount skills into every agent run, from a git source or from your uploads. |
49
+ | [Secrets](/core-concepts/secrets) | Store env secrets once and attach them to jobs by name. |
50
+ | [Upload a job](/core-concepts/upload) | Bring a job you ran elsewhere onto the platform as a finished job. |
51
+
52
+ ### Dashboard
53
+
54
+ | Page | What it covers |
55
+ | --- | --- |
56
+ | [Datasets](/dashboard/datasets) | Browse the catalog, and each dataset's tasks and versions, in the dashboard. |
57
+ | [Jobs](/dashboard/jobs) | Start a job from the browser, follow it, and read its results. |
58
+ | [Trial viewer](/dashboard/trial-viewer) | Read one trial's trace event by event, its tool calls, its spend, and download its artifacts. |
59
+ | [Checks](/dashboard/checks) | Read a job's task quality checks in the dashboard. |
60
+ | [Traces](/dashboard/traces) | Every recorded run in one list. |
61
+
62
+ ### SDK
63
+
64
+ | Page | What it covers |
65
+ | --- | --- |
66
+ | [TypeScript SDK](/sdk/typescript) | Start a job, wait for it, read the result, and download it from TypeScript. |
67
+ | [Python SDK](/sdk/python) | Start a job, wait for it, read the result, and download it from Python. |
68
+
69
+ ## CLI reference
70
+
71
+ ### The evolve command
72
+
73
+ | Page | What it covers |
74
+ | --- | --- |
75
+ | [CLI reference](/cli-reference/index) | Every verb of the evolve command, from its own help output. |
76
+ | [evolve run](/cli-reference/run) | Start a job, and optionally follow it to the end. |
77
+ | [evolve analyze](/cli-reference/analyze) | Analyze a finished job's trial traces against a rubric, on the platform. |
78
+ | [evolve check](/cli-reference/check) | Check task quality against a rubric, and read checks back. |
79
+ | [evolve upload](/cli-reference/upload) | Upload a job directory as a finished job. |
80
+
81
+ ### Command groups
82
+
83
+ | Page | What it covers |
84
+ | --- | --- |
85
+ | [evolve job](/cli-reference/job) | Start, follow, and derive jobs. |
86
+ | [evolve trial](/cli-reference/trial) | Inspect, download, and act on single trials. |
87
+ | [evolve analysis](/cli-reference/analysis) | List, inspect, and download trace-analysis runs. |
88
+ | [evolve dataset](/cli-reference/dataset) | Browse and publish the dataset catalog. |
89
+ | [evolve skill](/cli-reference/skill) | Upload and manage platform-stored skills. |
90
+ | [evolve skills](/cli-reference/skills) | The skills the CLI serves to coding agents. |
91
+ | [evolve agent](/cli-reference/agent) | Register and manage your own agents. |
92
+ | [evolve auth](/cli-reference/auth) | Identity, API keys, and your organizations. |
93
+ | [evolve secrets](/cli-reference/secrets) | Store and manage env secrets. Values are write-only; reads return metadata. |
94
+
95
+ ## SDK reference
96
+
97
+ ### Clients
98
+
99
+ | Page | What it covers |
100
+ | --- | --- |
101
+ | [Clients](/sdk-reference/index) | How the hosted clients are built and configured. |
102
+ | [jobs](/sdk-reference/jobs) | Start, follow, and derive jobs. |
103
+ | [trials](/sdk-reference/trials) | Read, download, and act on single trials. |
104
+ | [datasets](/sdk-reference/datasets) | The catalog: list, read, publish, download, activate, delete. |
105
+ | [analyses](/sdk-reference/analyses) | Read trace-analysis runs. |
106
+ | [checks](/sdk-reference/checks) | Start and read task quality checks. |
107
+ | [skills](/sdk-reference/skills) | Upload and manage platform-stored skills. |
108
+ | [agents](/sdk-reference/agents) | Register and manage your own agents. |
109
+ | [auth and orgs](/sdk-reference/auth) | Who you are, and your organizations. |
110
+ | [meta](/sdk-reference/meta) | The platform's capability document, no key needed. |
111
+ | [Types](/sdk-reference/types) | Every field of the objects the clients return: name, type, meaning, and when it is null. |
112
+ | [Errors](/sdk-reference/errors) | The error class every refused request raises, and every code it can carry. |
@@ -0,0 +1,67 @@
1
+ ---
2
+ title: "evolve agent"
3
+ description: "Register and manage your own agents."
4
+ ---
5
+
6
+ import GlobalOptions from '/snippets/global-options.mdx';
7
+ import ListFlags from '/snippets/list-flags.mdx';
8
+
9
+ ```bash
10
+ evolve agent <command> [options]
11
+ ```
12
+
13
+ ## agent list
14
+
15
+ ```bash
16
+ evolve agent list [options]
17
+ ```
18
+
19
+ List your registered agents.
20
+
21
+ <ListFlags />
22
+
23
+ ## agent show
24
+
25
+ ```bash
26
+ evolve agent show <name>
27
+ ```
28
+
29
+ Show one registered agent.
30
+
31
+ ## agent add
32
+
33
+ ```bash
34
+ evolve agent add <name> [options]
35
+ ```
36
+
37
+ Register an agent from an install script or a local directory.
38
+
39
+ <ParamField path="--install-script" type="path">
40
+ Install script file. Its contents are uploaded.
41
+ </ParamField>
42
+
43
+ <ParamField path="--dir" type="path">
44
+ Local agent directory, tarred and uploaded.
45
+ </ParamField>
46
+
47
+ <ParamField path="--run" type="command" required>
48
+ Run command, executed with `sh -c`.
49
+ </ParamField>
50
+
51
+ <ParamField path="--ae, --agent-env" type="KEY=VALUE">
52
+ Environment injected at run time. Repeatable. It may not override the six run-contract keys, and a credential-shaped key is refused, both with `agent_invalid_env`; see [the run contract](/core-concepts/agents#the-run-contract).
53
+ </ParamField>
54
+
55
+ ```bash
56
+ evolve agent add acme-cli --install-script ./install.sh --run "acme-cli --headless"
57
+ ```
58
+
59
+ ## agent remove
60
+
61
+ ```bash
62
+ evolve agent remove <name>
63
+ ```
64
+
65
+ Delete a registered agent. Past jobs keep their record.
66
+
67
+ <GlobalOptions />
@@ -0,0 +1,91 @@
1
+ ---
2
+ title: "evolve analysis"
3
+ description: "List, inspect, and download trace-analysis runs."
4
+ ---
5
+
6
+ import GlobalOptions from '/snippets/global-options.mdx';
7
+ import ListFlags from '/snippets/list-flags.mdx';
8
+
9
+ ```bash
10
+ evolve analysis <command> [options]
11
+ ```
12
+
13
+ `show`, `trace` and `download` take an analysis id, or a trial id. An analysis id (or its unambiguous prefix) names that run. A trial id (or prefix) names the trial's latest analysis, the one `trial show` prints on its analysis row. A prefix matching both an analysis and a trial is refused as ambiguous, naming both.
14
+
15
+ A trial nobody analyzed is refused with the remedy, `evolve analyze <job>`, and so is a regrade result's id. An id you cannot read answers `analysis_not_found`; `download` on a run still queued or running answers `analysis_not_terminal`.
16
+
17
+ ## analysis list
18
+
19
+ ```bash
20
+ evolve analysis list [options]
21
+ ```
22
+
23
+ List analysis runs, newest first, with the trial, job and task each one judged.
24
+
25
+ <ListFlags />
26
+
27
+ <ParamField path="--scope" type="my | shared">
28
+ Visibility scope: `my`, what you created (the default), or `shared`, your organizations' rows that teammates created.
29
+ </ParamField>
30
+
31
+ <ParamField path="--job" type="job-id">
32
+ Only analyses of this job's trials. An id, or an unambiguous prefix.
33
+ </ParamField>
34
+
35
+ <ParamField path="--status" type="s1,s2,...">
36
+ Filter by analysis status: `queued`, `running`, `completed`, `failed`.
37
+ </ParamField>
38
+
39
+ ```bash
40
+ evolve analysis list --job 3e1f9a2c-… --status failed
41
+ ```
42
+
43
+ ## analysis show
44
+
45
+ ```bash
46
+ evolve analysis show <analysis-id | trial-id>
47
+ ```
48
+
49
+ Show one analysis run in full: the verdict document.
50
+
51
+ ## analysis trace
52
+
53
+ ```bash
54
+ evolve analysis trace <analysis-id | trial-id> [options]
55
+ ```
56
+
57
+ Print the analyzer's own parsed transcript.
58
+
59
+ <ParamField path="--since" type="n">
60
+ Skip the first N events. To resume, pass the count you already hold; sequence numbers are dense from 0, so N is also the next one.
61
+ </ParamField>
62
+
63
+ ## analysis download
64
+
65
+ ```bash
66
+ evolve analysis download <analysis-id | trial-id> [options]
67
+ ```
68
+
69
+ Save an analysis run as a trial folder plus `evolve.json`, or stream one artifact.
70
+
71
+ <ParamField path="-o, --output-dir" type="dir" default="analyses/">
72
+ Directory to save under. The run lands in `<dir>/analyze-<analyzed trial>__<7 chars>/`, the run's own folder name, read from the archive.
73
+ </ParamField>
74
+
75
+ <ParamField path="--overwrite">
76
+ Replace an existing folder of the same name.
77
+ </ParamField>
78
+
79
+ <ParamField path="--stream" type="artifact">
80
+ Print one artifact to stdout instead of saving: `analysis` (the verdict document), `trace-parsed`, `trace-stdout`, `trace-stderr` or `agent-home`.
81
+ </ParamField>
82
+
83
+ <ParamField path="--since" type="n">
84
+ With `--stream trace-parsed`: skip the first N events.
85
+ </ParamField>
86
+
87
+ ```bash
88
+ evolve analysis download a0a1b2c3-… --stream trace-stdout
89
+ ```
90
+
91
+ <GlobalOptions />
@@ -0,0 +1,74 @@
1
+ ---
2
+ title: "evolve analyze"
3
+ description: "Analyze a finished job's trial traces against a rubric, on the platform."
4
+ ---
5
+
6
+ import GlobalOptions from '/snippets/global-options.mdx';
7
+
8
+ ```bash
9
+ evolve analyze <job-id> [options]
10
+ ```
11
+
12
+ Analyze a terminal job's trial traces against a rubric, server-side. Without `--watch` the command returns at once with the job block and the hint `Follow it with: evolve job show <id>`; `--json` prints the accepted job body. Exit 0 on an accepted wave; with `--watch`, exit 1 when any analysis failed.
13
+
14
+ ```bash
15
+ evolve analyze 3e1f9a2c-… \
16
+ -r rubric.toml \
17
+ -p prompt.txt \
18
+ --failing \
19
+ -l 20 \
20
+ -n 2 \
21
+ --watch
22
+ ```
23
+
24
+ ## Options
25
+
26
+ <ParamField path="-m, --model" type="name" default="openrouter/deepseek/deepseek-v4.1-flash">
27
+ Model the analyzer runs. `glm-5.3-flash` and `haiku` are alternatives, `glm-5.3` escalates, and `fireworks/deepseek-v4.1-flash` is the same model on its Fireworks route. Must be on the `claude` roster.
28
+ </ParamField>
29
+
30
+ <ParamField path="--effort" type="value">
31
+ Reasoning effort the analyzer runs at. Defaults to the per-model default: `high` on `openrouter/deepseek/deepseek-v4.1-flash`, `max` on `glm-5.3-flash`.
32
+ </ParamField>
33
+
34
+ <ParamField path="-r, --rubric" type="path">
35
+ Rubric file: TOML (one `[[criteria]]` table per criterion), YAML or JSON in the `{criteria: [{name, description, guidance}]}` shape, parsed at the keyboard with unknown fields refused by name; the server owns the bounds. Defaults to the platform's analyze rubric, seven criteria with `score_is_earned` first.
36
+ </ParamField>
37
+
38
+ <ParamField path="-p, --prompt" type="path">
39
+ Prompt file for the evaluator agent; its text replaces the built-in prompt, with `{trial_path}`, `{task_section}` and `{criteria_guidance}` rendered, `{{` and `}}` writing a literal brace, and an unknown `{token}` rendering empty. The instructions for writing the result are appended after it. An empty file is refused; there is no length bound. Defaults to the built-in prompt.
40
+ </ParamField>
41
+
42
+ <ParamField path="-e, --env" type="provider">
43
+ Sandbox provider the analyzer runs on. Defaults to `daytona`.
44
+ </ParamField>
45
+
46
+ <ParamField path="-n, --n-concurrent" type="n">
47
+ Max concurrent trial analyses, 1 to 150, beneath the organization's `max_concurrent_analyses` (fleet default 60). Defaults to the ceiling.
48
+ </ParamField>
49
+
50
+ <ParamField path="--passing">
51
+ Only analyze passing trials (reward 1.0).
52
+ </ParamField>
53
+
54
+ <ParamField path="--failing">
55
+ Only analyze failing trials (reward below 1.0, or an exception).
56
+ </ParamField>
57
+
58
+ <ParamField path="-l, --n-trials" type="n">
59
+ Max trials to analyze, after `--passing` or `--failing`, in the job's trial order.
60
+ </ParamField>
61
+
62
+ <ParamField path="--watch">
63
+ Poll until every analysis settles, then print one row per analyzed trial: the label (`custom rubric` when there is none), the criterion outcomes, the analyzer's cost and a summary excerpt, with failed analyses listed below. With `--json`, NDJSON envelopes: `analysis.accepted`, `analysis.stats` per change, `analysis.final` with the job and the analyzed trials.
64
+ </ParamField>
65
+
66
+ <ParamField path="-q, --quiet">
67
+ With `--watch`: suppress the progress lines and print the final block only.
68
+ </ParamField>
69
+
70
+ <GlobalOptions />
71
+
72
+ ## Reading analyses back
73
+
74
+ The [`analysis`](/cli-reference/analysis) group lists, shows, traces and downloads analysis runs.
@@ -0,0 +1,60 @@
1
+ ---
2
+ title: "evolve auth"
3
+ description: "Identity, API keys, and your organizations."
4
+ ---
5
+
6
+ import GlobalOptions from '/snippets/global-options.mdx';
7
+
8
+ ```bash
9
+ evolve auth <command> [options]
10
+ ```
11
+
12
+ ## auth status
13
+
14
+ ```bash
15
+ evolve auth status
16
+ ```
17
+
18
+ Who am I: the caller and the API key in use.
19
+
20
+ ## auth org list
21
+
22
+ ```bash
23
+ evolve auth org list [options]
24
+ ```
25
+
26
+ List the organizations you belong to.
27
+
28
+ <ParamField path="--search" type="text">
29
+ Free-text filter over slug, display name and role.
30
+ </ParamField>
31
+
32
+ <ParamField path="--columns" type="keys | all | help">
33
+ Choose and order columns, comma-separated. `help` lists the keys.
34
+ </ParamField>
35
+
36
+ <ParamField path="-q, --quiet">
37
+ Print only slugs, one per line, for piping.
38
+ </ParamField>
39
+
40
+ <ParamField path="--no-trunc">
41
+ Full cell content instead of one-line truncation.
42
+ </ParamField>
43
+
44
+ <ParamField path="--no-headers">
45
+ Omit the header row in piped (TSV) output.
46
+ </ParamField>
47
+
48
+ ## auth org show
49
+
50
+ ```bash
51
+ evolve auth org show <slug>
52
+ ```
53
+
54
+ Show one organization: your role, its members, its quota and live usage.
55
+
56
+ ```bash
57
+ evolve auth org show acme
58
+ ```
59
+
60
+ <GlobalOptions />
@@ -0,0 +1,146 @@
1
+ ---
2
+ title: "evolve check"
3
+ description: "Check task quality against a rubric, and read checks back."
4
+ ---
5
+
6
+ import GlobalOptions from '/snippets/global-options.mdx';
7
+ import ListFlags from '/snippets/list-flags.mdx';
8
+
9
+ ```bash
10
+ evolve check [<path>] [options]
11
+ ```
12
+
13
+ Check task quality against a rubric, server-side. `<path>` is one task directory or a directory of task directories, uploaded as one archive (`upload_too_large` past the published ceiling); `-d` names a published dataset instead, one or the other. Without `--watch` the command prints the accepted check with the hint `Follow it with: evolve check show <id>`; `--json` prints the accepted check body. Exit 0 on an accepted check; with `--watch`, and on `check show`, exit 1 when any task errored.
14
+
15
+ ```bash
16
+ evolve check ./tasks \
17
+ -i 'abs-*' \
18
+ -l 5 \
19
+ --watch
20
+ ```
21
+
22
+ ## Options
23
+
24
+ <ParamField path="-d, --dataset" type="name[@version]">
25
+ Check a published dataset's tasks instead of a local path. The checker reads the version's retained task package, and the job page's CHECK tab lists these checks by task.
26
+ </ParamField>
27
+
28
+ <ParamField path="-m, --model" type="name" default="openrouter/deepseek/deepseek-v4.1-flash">
29
+ Model the checker runs. `fireworks/deepseek-v4.1-flash` is the same model on its Fireworks route. Must be on the `claude` roster.
30
+ </ParamField>
31
+
32
+ <ParamField path="--effort" type="value">
33
+ Reasoning effort the checker runs at. Defaults to the per-model default.
34
+ </ParamField>
35
+
36
+ <ParamField path="-r, --rubric" type="path">
37
+ Rubric file: TOML, YAML or JSON in the `{criteria: [{name, description, guidance}]}` shape. Defaults to the platform's check rubric, eleven criteria.
38
+ </ParamField>
39
+
40
+ <ParamField path="-p, --prompt" type="path">
41
+ Prompt file for the evaluator agent. Its text replaces the built-in check prompt, with `{task_path}`, `{file_tree}` and `{criteria_guidance}` rendered. Defaults to the built-in prompt.
42
+ </ParamField>
43
+
44
+ <ParamField path="-e, --env" type="provider">
45
+ Sandbox provider the checker runs on. Defaults to the platform's analysis default.
46
+ </ParamField>
47
+
48
+ <ParamField path="-n, --n-concurrent" type="n">
49
+ Max concurrent task checks, beneath the organization's ceiling. Defaults to the ceiling.
50
+ </ParamField>
51
+
52
+ <ParamField path="-i, --include-task-name" type="glob">
53
+ Only check tasks matching the glob. Repeatable.
54
+ </ParamField>
55
+
56
+ <ParamField path="-x, --exclude-task-name" type="glob">
57
+ Skip tasks matching the glob. Repeatable.
58
+ </ParamField>
59
+
60
+ <ParamField path="-l, --n-tasks" type="n">
61
+ Max tasks to check, after the globs, in sorted directory order.
62
+ </ParamField>
63
+
64
+ <ParamField path="--watch">
65
+ Poll until every task check settles, then print the report. One task prints its label line, a `CHECK | OUTCOME | EXPLANATION` table with the evidence beneath each verdict, and the cost; several tasks print a `TASK | LABEL | PASS | FAIL | N/A | UNKNOWN | COST ($) | TASK CHECK ID` table with each failed task's reason below it. With `--json`, NDJSON envelopes: `check.accepted`, `check.progress` per change, `check.final`.
66
+ </ParamField>
67
+
68
+ <ParamField path="-q, --quiet">
69
+ With `--watch`: suppress the progress lines and print the final report only.
70
+ </ParamField>
71
+
72
+ <GlobalOptions />
73
+
74
+ ## Reading checks back
75
+
76
+ The same word, followed by `list`, `show`, `trace` or `download`, reads checks back. A task directory literally named like one of these verbs is written `./list`.
77
+
78
+ ### check list
79
+
80
+ ```bash
81
+ evolve check list [options]
82
+ ```
83
+
84
+ List your task quality checks, newest first.
85
+
86
+ <ListFlags />
87
+
88
+ <ParamField path="--scope" type="my | shared">
89
+ Visibility scope: `my`, what you created (the default), or `shared`, your organizations' rows that teammates created.
90
+ </ParamField>
91
+
92
+ <ParamField path="--status" type="s1,s2,...">
93
+ Filter by check status: `queued`, `running`, `completed`.
94
+ </ParamField>
95
+
96
+ ```bash
97
+ evolve check list --status running
98
+ ```
99
+
100
+ ### check show
101
+
102
+ ```bash
103
+ evolve check show <check-id>
104
+ ```
105
+
106
+ Show one task quality check in full, with one result per task.
107
+
108
+ ### check trace
109
+
110
+ ```bash
111
+ evolve check trace <task-check-id> [options]
112
+ ```
113
+
114
+ Print the checker's own parsed transcript for one task check.
115
+
116
+ <ParamField path="--since" type="n">
117
+ Skip the first N events. To resume, pass the count you already hold.
118
+ </ParamField>
119
+
120
+ ### check download
121
+
122
+ ```bash
123
+ evolve check download <check-id | task-check-id> [options]
124
+ ```
125
+
126
+ Save a check as a check folder (`check_report.json` plus one folder per task) by its check id, one task check's folder by its task check id, or stream one task check's artifact.
127
+
128
+ <ParamField path="-o, --output-dir" type="dir" default="checks/">
129
+ Directory to save under. A check id lands in `<dir>/check-<id>/`, a task check id in `<dir>/check-<task>__<7 chars>/`, the run's own folder name.
130
+ </ParamField>
131
+
132
+ <ParamField path="--overwrite">
133
+ Replace an existing folder of the same name.
134
+ </ParamField>
135
+
136
+ <ParamField path="--stream" type="artifact">
137
+ Print one artifact of a task check to stdout instead of saving: `task-check` (the result document), `trace-parsed`, `trace-stdout`, `trace-stderr` or `agent-home`.
138
+ </ParamField>
139
+
140
+ <ParamField path="--since" type="n">
141
+ With `--stream trace-parsed`: skip the first N events.
142
+ </ParamField>
143
+
144
+ ```bash
145
+ evolve check download 3f9a1c2e-… -o checks/
146
+ ```