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

package/docs-agents/typescript/index.md

@@ -1,121 +0,0 @@
-# Evolve TypeScript SDK
-
-Run CLI agents in secure sandboxes with built-in observability.
-
-```bash
-npm install @evolvingmachines/evolve
-```
-
-```ts
-import { Evolve } from "@evolvingmachines/evolve";
-
-const evolve = new Evolve();
-await evolve.run({ prompt: "Hello world" });
-```
-
----
-
-## Reference
-
-### Getting Started
-
-| Topic | Link |
-|-------|------|
-| Installation (Node.js 18+, npm) | [Getting Started → Installation](./01-getting-started.md#installation) |
-| Quick Start (3 steps) | [Getting Started → Quick Start](./01-getting-started.md#quick-start) |
-| Core Lifecycle (run → getOutputFiles → kill) | [Getting Started → Core Lifecycle](./01-getting-started.md#core-lifecycle) |
-| Streaming basics | [Getting Started → Streaming](./01-getting-started.md#streaming) |
-| Gateway, managed BYO provider keys, and direct keys | [Getting Started → Authentication](./01-getting-started.md#authentication) |
-| Gateway mode (EVOLVE_API_KEY) | [Getting Started → Gateway Mode](./01-getting-started.md#gateway-mode-evolve_api_key) |
-| Managed BYO provider keys | [Getting Started → Managed BYO Provider Keys](./01-getting-started.md#managed-byo-provider-keys) |
-| Managed secrets | [Configuration → Managed Secrets](./02-configuration.md#managed-secrets) |
-| Direct provider key mode (local BYOK) | [Getting Started → Direct Provider Key Mode](./01-getting-started.md#direct-provider-key-mode-local-byok) |
-| BYO Claude Max / Codex / Gemini subscription | [Getting Started → BYO Claude Max Subscription](./01-getting-started.md#byo-claude-max-subscription) |
-| Supported agents & models | [Getting Started → Agent Reference](./01-getting-started.md#agent-reference) |
-| Agent-specific options (reasoningEffort) | [Getting Started → Agent Reference](./01-getting-started.md#agent-reference) |
-
-### Configuration
-
-| Topic | Link |
-|-------|------|
-| Sandbox providers (E2B, Modal, Daytona) | [Configuration → Sandbox Providers](./02-configuration.md#sandbox-providers) |
-| Provider auto-resolution from env | [Configuration → Sandbox Providers](./02-configuration.md#auto-resolution) |
-| `.withSandboxCreateOptions()` (image, network, user, homeDir) | [Configuration → Sandbox Create Options](./02-configuration.md#sandbox-create-options) |
-| `.withWorkspaceMode()` (knowledge / swe) | [Configuration → Workspace Modes](./02-configuration.md#workspace-modes) |
-| Evolve instance (full `.with*()` API) | [Configuration → Evolve Instance](./02-configuration.md#evolve-instance) |
-| `.withAgent()` | [Configuration → Evolve Instance](./02-configuration.md#evolve-instance) |
-| `.withSandbox()` | [Configuration → Sandbox Providers](./02-configuration.md#sandbox-providers) |
-| `.withContext()` / `.withFiles()` | [Configuration → Evolve Instance](./02-configuration.md#evolve-instance) |
-| `.withSystemPrompt()` | [Configuration → Evolve Instance](./02-configuration.md#evolve-instance) |
-| `.withSchema()` (Zod / JSON Schema) | [Configuration → Evolve Instance](./02-configuration.md#evolve-instance) |
-| `.withBrowser()` browser guide | [Configuration → Browser Automation](./02-configuration.md#browser-automation) |
-| `.withBrowserCredentials()` browser logins | [Configuration → Browser Credentials](./02-configuration.md#browser-credentials) |
-| `.withPlugins()` | [Configuration → Agent Plugins](./02-configuration.md#agent-plugins) |
-| `.withSkills()` | [Configuration → Agent Skills](./02-configuration.md#agent-skills) |
-| `.withIntegrations()` (managed app integrations) | [Configuration → Managed Integrations](./02-configuration.md#managed-integrations) |
-| `.withManagedSecrets()` | [Configuration → Managed Secrets](./02-configuration.md#managed-secrets) |
-| `.withMcpServers()` (STDIO / HTTP / SSE) | [Configuration → Evolve Instance](./02-configuration.md#evolve-instance) |
-| `.withSecrets()` | [Configuration → Evolve Instance](./02-configuration.md#evolve-instance) |
-| `.withStorage()` (checkpointing) | [Runtime → Storage & Checkpointing](./03-runtime.md#storage--checkpointing) |
-| `.withSessionTagPrefix()` (observability) | [Runtime → Observability](./03-runtime.md#observability) |
-| Skills catalog (PDF, browser, research, etc.) | [Configuration → Agent Skills](./02-configuration.md#agent-skills) |
-| Integration auth/account helpers | [Configuration → Managed Integrations](./02-configuration.md#managed-integrations) |
-| Integration tool filtering | [Configuration → Managed Integrations](./02-configuration.md#managed-integrations) |
-| MCP server config (McpServerConfig) | [Configuration → Evolve Instance](./02-configuration.md#evolve-instance) |
-
-### Runtime
-
-| Topic | Link |
-|-------|------|
-| `run()` | [Runtime → run](./03-runtime.md#run) |
-| `executeCommand()` | [Runtime → executeCommand](./03-runtime.md#executecommand) |
-| Streaming events (content, lifecycle, stdout, stderr) | [Streaming Events](./04-streaming.md) |
-| OutputEvent / SessionUpdate types | [Streaming → SessionUpdate Types](./04-streaming.md#sessionupdate-types) |
-| LifecycleEvent / LifecycleReason | [Streaming → LifecycleEvent](./04-streaming.md#lifecycleevent) |
-| Tool events (ToolCall, ToolCallUpdate, ToolKind) | [Streaming → Tool Events](./04-streaming.md#tool-events) |
-| Browser lifecycle event fields | [Streaming → Browser Automation Streaming](./04-streaming.md#browser-automation-streaming) |
-| UI integration example | [Streaming → UI Integration Example](./04-streaming.md#ui-integration-example) |
-| Upload files (`uploadContext()`, `uploadFiles()`) | [Runtime → Upload](./03-runtime.md#upload-local--sandbox) |
-| Download files (`getOutputFiles()`, `saveLocalDir()`) | [Runtime → Download](./03-runtime.md#download-sandbox--local) |
-| Session controls (interrupt, pause, resume, kill) | [Runtime → Session Controls](./03-runtime.md#session-controls) |
-| `getHost()` (port forwarding) | [Runtime → getHost](./03-runtime.md#gethost) |
-| Workspace filesystem layout | [Runtime → Workspace & Structured Output](./03-runtime.md#workspace--structured-output) |
-| Structured output (Zod / JSON Schema) | [Runtime → Workspace & Structured Output](./03-runtime.md#structured-output) |
-| Multi-turn conversations | [Runtime → Session Management](./03-runtime.md#session-management) |
-| Pause / resume | [Runtime → Session Management](./03-runtime.md#session-management) |
-| Save and reconnect (`withSession`, `setSession`) | [Runtime → Session Management](./03-runtime.md#session-management) |
-| Storage & checkpointing (gateway) | [Runtime → Storage & Checkpointing](./03-runtime.md#storage--checkpointing) |
-| Auto-checkpoint, explicit checkpoint, restore | [Runtime → Storage & Checkpointing](./03-runtime.md#auto-checkpoint-via-run) |
-| Checkpoint lineage | [Runtime → Checkpoint Lineage](./03-runtime.md#checkpoint-lineage) |
-| `storage()` client, `evolve.storage()` | [Runtime → Listing & Browsing Checkpoints](./03-runtime.md#listing--browsing-checkpoints) |
-| `sessions()` client for past sessions & traces | [Runtime → Historical Sessions & Trace Download](./03-runtime.md#historical-sessions--trace-download) |
-| Observability (dashboard + local logs) | [Runtime → Observability](./03-runtime.md#observability) |
-| Error handling | [Runtime → Error Handling](./03-runtime.md#error-handling) |
-
-### Hosted evals
-
-Datasets, jobs, trials, checks, analyses and the `evolve` CLI are documented at https://docs.evolvingmachines.ai. The `evolve-evals` skill carries the same pages.
-
-### Swarm & Pipeline
-
-| Topic | Link |
-|-------|------|
-| Swarm setup (SwarmConfig) | [Swarm & Pipeline](./05-swarm-pipeline.md) |
-| Input types (FileMap, folders, chaining) | [Swarm → Input Types](./05-swarm-pipeline.md#input-types) |
-| `bestOf()` (N candidates + judge) | [Swarm → bestOf](./05-swarm-pipeline.md#bestof) |
-| `map()` (parallel processing) | [Swarm → map](./05-swarm-pipeline.md#map) |
-| `map()` + bestOf | [Swarm → map + bestOf](./05-swarm-pipeline.md#map--bestof) |
-| `filter()` (evaluate + threshold) | [Swarm → filter](./05-swarm-pipeline.md#filter) |
-| `reduce()` (synthesize many → one) | [Swarm → reduce](./05-swarm-pipeline.md#reduce) |
-| `verify` (quality gate with feedback loop) | [Swarm → verify](./05-swarm-pipeline.md#verify-quality-gate) |
-| Result types (SwarmResult, ReduceResult, BestOfResult) | [Swarm → Result Types](./05-swarm-pipeline.md#result-types) |
-| Chaining operations (result.json → data.json) | [Swarm → Chaining Operations](./05-swarm-pipeline.md#chaining-operations) |
-| AgentOverride (per-operation agent config) | [Swarm → AgentOverride](./05-swarm-pipeline.md#agentoverride) |
-| Concurrency (semaphore, ordering guarantees) | [Swarm → Concurrency](./05-swarm-pipeline.md#concurrency) |
-| RetryConfig (exponential backoff) | [Swarm & Pipeline](./05-swarm-pipeline.md) |
-| Pipeline (fluent chaining) | [Swarm → Pipeline](./05-swarm-pipeline.md#pipeline) |
-| Pipeline step configs (map, filter, reduce) | [Swarm → Step Configurations](./05-swarm-pipeline.md#step-configurations) |
-| Pipeline events (stepStart, stepComplete, etc.) | [Swarm → Events](./05-swarm-pipeline.md#events) |
-| Pipeline result (PipelineResult) | [Swarm → Result](./05-swarm-pipeline.md#result) |
-| TerminalPipeline (reduce is terminal) | [Swarm → Terminal Pipeline](./05-swarm-pipeline.md#terminal-pipeline) |
-| Filter `emit` option (success / filtered / all) | [Swarm → Pipeline](./05-swarm-pipeline.md#step-configurations) |

package/docs-evals/SKILL.md

@@ -1,112 +0,0 @@
----
-# Generated by scripts/generate-skills.ts from docs-evals/docs.json. Do not edit; edit the source and run npm run generate:skills.
-name: docs-evals
-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`."
-metadata:
-  internal: true
----
-
-# Evolve hosted evals
-
-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.
-
-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>`.
-
-## How to use this skill
-
-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.
-2. Every CLI verb is documented from its own `--help`; run `evolve <verb> --help` to confirm the flags of the installed version.
-3. Every command and every SDK client reads `EVOLVE_API_KEY`; the Installation page says where the key comes from.
-
-## Topic index
-
-## Docs
-
-### Getting started
-
-| Page | What it covers |
-| --- | --- |
-| [Evolve documentation](/index) | Environment-driven agent evaluations: any model, any harness, any sandbox, one API key. Every task versioned and checked, every trajectory analyzed. |
-| [Installation](/getting-started/installation) | Install the evolve command and the SDKs, and set your API key. |
-| [Quick start](/getting-started/quick-start) | Start your first job, watch it run, and download a trial. |
-
-### Core concepts
-
-| Page | What it covers |
-| --- | --- |
-| [Core concepts](/core-concepts/index) | How a dataset becomes trials, rewards, analyses and results. |
-| [Tasks](/core-concepts/tasks) | The task format: one directory with an instruction, an environment, a verifier, and an optional reference solution. |
-| [Datasets](/core-concepts/datasets) | The catalog, and publishing your own dataset. |
-| [Jobs](/core-concepts/jobs) | Start a job, watch it, read its results, and derive new jobs from it. |
-| [Trials](/core-concepts/trials) | One agent's attempt at one task: its record, its trace, and its artifacts. |
-| [Trial outputs](/core-concepts/trial-outputs) | What a finished trial gives you, file by file, and in which formats. |
-| [Agents](/core-concepts/agents) | The built-in harnesses, how to configure an arm, and how to register your own agent. |
-| [Models](/core-concepts/models) | How a model is named on -m, and why one API key covers every provider. |
-| [Sandboxes](/core-concepts/sandboxes) | Where trials run: e2b, daytona, or modal. |
-| [Analyze](/core-concepts/analyze) | Judge every trial's trace against a rubric, on the platform. |
-| [Check](/core-concepts/check) | Check the quality of tasks against a rubric before you spend a job on them. |
-| [Skills](/core-concepts/skills) | Mount skills into every agent run, from a git source or from your uploads. |
-| [Secrets](/core-concepts/secrets) | Store env secrets once and attach them to jobs by name. |
-| [Upload a job](/core-concepts/upload) | Bring a job you ran elsewhere onto the platform as a finished job. |
-
-### Dashboard
-
-| Page | What it covers |
-| --- | --- |
-| [Datasets](/dashboard/datasets) | Browse the catalog, and each dataset's tasks and versions, in the dashboard. |
-| [Jobs](/dashboard/jobs) | Start a job from the browser, follow it, and read its results. |
-| [Trial viewer](/dashboard/trial-viewer) | Read one trial's trace event by event, its tool calls, its spend, and download its artifacts. |
-| [Checks](/dashboard/checks) | Read a job's task quality checks in the dashboard. |
-| [Traces](/dashboard/traces) | Every recorded run in one list. |
-
-### SDK
-
-| Page | What it covers |
-| --- | --- |
-| [TypeScript SDK](/sdk/typescript) | Start a job, wait for it, read the result, and download it from TypeScript. |
-| [Python SDK](/sdk/python) | Start a job, wait for it, read the result, and download it from Python. |
-
-## CLI reference
-
-### The evolve command
-
-| Page | What it covers |
-| --- | --- |
-| [CLI reference](/cli-reference/index) | Every verb of the evolve command, from its own help output. |
-| [evolve run](/cli-reference/run) | Start a job, and optionally follow it to the end. |
-| [evolve analyze](/cli-reference/analyze) | Analyze a finished job's trial traces against a rubric, on the platform. |
-| [evolve check](/cli-reference/check) | Check task quality against a rubric, and read checks back. |
-| [evolve upload](/cli-reference/upload) | Upload a job directory as a finished job. |
-
-### Command groups
-
-| Page | What it covers |
-| --- | --- |
-| [evolve job](/cli-reference/job) | Start, follow, and derive jobs. |
-| [evolve trial](/cli-reference/trial) | Inspect, download, and act on single trials. |
-| [evolve analysis](/cli-reference/analysis) | List, inspect, and download trace-analysis runs. |
-| [evolve dataset](/cli-reference/dataset) | Browse and publish the dataset catalog. |
-| [evolve skill](/cli-reference/skill) | Upload and manage platform-stored skills. |
-| [evolve skills](/cli-reference/skills) | The skills the CLI serves to coding agents. |
-| [evolve agent](/cli-reference/agent) | Register and manage your own agents. |
-| [evolve auth](/cli-reference/auth) | Identity, API keys, and your organizations. |
-| [evolve secrets](/cli-reference/secrets) | Store and manage env secrets. Values are write-only; reads return metadata. |
-
-## SDK reference
-
-### Clients
-
-| Page | What it covers |
-| --- | --- |
-| [Clients](/sdk-reference/index) | How the hosted clients are built and configured. |
-| [jobs](/sdk-reference/jobs) | Start, follow, and derive jobs. |
-| [trials](/sdk-reference/trials) | Read, download, and act on single trials. |
-| [datasets](/sdk-reference/datasets) | The catalog: list, read, publish, download, activate, delete. |
-| [analyses](/sdk-reference/analyses) | Read trace-analysis runs. |
-| [checks](/sdk-reference/checks) | Start and read task quality checks. |
-| [skills](/sdk-reference/skills) | Upload and manage platform-stored skills. |
-| [agents](/sdk-reference/agents) | Register and manage your own agents. |
-| [auth and orgs](/sdk-reference/auth) | Who you are, and your organizations. |
-| [meta](/sdk-reference/meta) | The platform's capability document, no key needed. |
-| [Types](/sdk-reference/types) | Every field of the objects the clients return: name, type, meaning, and when it is null. |
-| [Errors](/sdk-reference/errors) | The error class every refused request raises, and every code it can carry. |

package/docs-evals/docs.json

@@ -1,180 +0,0 @@
-{
-  "$schema": "https://mintlify.com/docs.json",
-  "name": "Evolve",
-  "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`.",
-  "theme": "maple",
-  "colors": {
-    "primary": "#B026FF",
-    "light": "#B026FF",
-    "dark": "#B026FF"
-  },
-  "favicon": "/favicon.png",
-  "logo": {
-    "light": "/logo/wordmark-light.png",
-    "dark": "/logo/wordmark-dark.png",
-    "href": "https://evolvingmachines.ai"
-  },
-  "appearance": {
-    "default": "light"
-  },
-  "background": {
-    "color": {
-      "light": "#f7f6f5",
-      "dark": "#0a0a0a"
-    }
-  },
-  "fonts": {
-    "family": "Google Sans Flex",
-    "weight": 400,
-    "heading": {
-      "family": "Google Sans Flex",
-      "weight": 600
-    }
-  },
-  "icons": {
-    "library": "lucide"
-  },
-  "styling": {
-    "eyebrows": "breadcrumbs",
-    "codeblocks": "dark"
-  },
-  "navbar": {
-    "links": [
-      {
-        "type": "github",
-        "href": "https://github.com/evolving-machines-lab/evolve"
-      }
-    ],
-    "primary": {
-      "type": "button",
-      "label": "Dashboard",
-      "href": "https://dashboard.evolvingmachines.ai"
-    }
-  },
-  "footer": {
-    "socials": {
-      "website": "https://evolvingmachines.ai",
-      "github": "https://github.com/evolving-machines-lab/evolve",
-      "discord": "https://discord.gg/Q36D8dGyNF"
-    }
-  },
-  "contextual": {
-    "options": [
-      "copy",
-      "view",
-      "claude",
-      "chatgpt"
-    ],
-    "display": "header"
-  },
-  "redirects": [
-    {
-      "source": "/core-concepts/tasks-and-datasets",
-      "destination": "/core-concepts/datasets"
-    }
-  ],
-  "navigation": {
-    "tabs": [
-      {
-        "tab": "Docs",
-        "groups": [
-          {
-            "group": "Getting started",
-            "pages": [
-              "index",
-              "getting-started/installation",
-              "getting-started/quick-start"
-            ]
-          },
-          {
-            "group": "Core concepts",
-            "pages": [
-              "core-concepts/index",
-              "core-concepts/tasks",
-              "core-concepts/datasets",
-              "core-concepts/jobs",
-              "core-concepts/trials",
-              "core-concepts/trial-outputs",
-              "core-concepts/agents",
-              "core-concepts/models",
-              "core-concepts/sandboxes",
-              "core-concepts/analyze",
-              "core-concepts/check",
-              "core-concepts/skills",
-              "core-concepts/secrets",
-              "core-concepts/upload"
-            ]
-          },
-          {
-            "group": "Dashboard",
-            "pages": [
-              "dashboard/datasets",
-              "dashboard/jobs",
-              "dashboard/trial-viewer",
-              "dashboard/checks",
-              "dashboard/traces"
-            ]
-          },
-          {
-            "group": "SDK",
-            "pages": [
-              "sdk/typescript",
-              "sdk/python"
-            ]
-          }
-        ]
-      },
-      {
-        "tab": "CLI reference",
-        "groups": [
-          {
-            "group": "The evolve command",
-            "pages": [
-              "cli-reference/index",
-              "cli-reference/run",
-              "cli-reference/analyze",
-              "cli-reference/check",
-              "cli-reference/upload"
-            ]
-          },
-          {
-            "group": "Command groups",
-            "pages": [
-              "cli-reference/job",
-              "cli-reference/trial",
-              "cli-reference/analysis",
-              "cli-reference/dataset",
-              "cli-reference/skill",
-              "cli-reference/skills",
-              "cli-reference/agent",
-              "cli-reference/auth",
-              "cli-reference/secrets"
-            ]
-          }
-        ]
-      },
-      {
-        "tab": "SDK reference",
-        "groups": [
-          {
-            "group": "Clients",
-            "pages": [
-              "sdk-reference/index",
-              "sdk-reference/jobs",
-              "sdk-reference/trials",
-              "sdk-reference/datasets",
-              "sdk-reference/analyses",
-              "sdk-reference/checks",
-              "sdk-reference/skills",
-              "sdk-reference/agents",
-              "sdk-reference/auth",
-              "sdk-reference/meta",
-              "sdk-reference/types",
-              "sdk-reference/errors"
-            ]
-          }
-        ]
-      }
-    ]
-  }
-}