Run compiled firmware on a chip-accurate virtual board and read what it printed, with no hardware on your desk.
You
Agents
Chiplab executes your firmware on a chip-accurate virtual board and returns the UART output you asked to capture, no physical hardware required.
Cross-compilation happens on your side.
Chiplab runs the ELF as-is.
The simulation platform today is Renode, with QEMU and more planned.
When to use it
Use a run when you want the printed output. When you need a pass or fail for each test, use test.
Ask your agent
Run this firmware on the STM32F4 Discovery and capture usart2.
Not sure which board fits your firmware? Ask Chiplab about individual board specs; board recommendation tooling is on the way.
What you get back
You get the captured UART output. succeeded means Chiplab completed the run. It does not mean your firmware behaved: a firmware that panics or faults still returns succeeded. Check the uart output for what you expect.A run lasts up to 5 seconds of virtual time.
Chip accuracy
Each virtual board runs your exact binary against a chip-accurate model of the target’s peripherals, memory map, and interrupt controller.
Peripheral coverage keeps growing. If your firmware depends on a peripheral or timing behavior Chiplab doesn’t model yet, ask Chiplab for the current coverage of your board.
Knowledge corpus
Every run deposits observed behavior into Chiplab’s knowledge corpus. Your firmware code and binaries are not part of it.
The agent workflow is a short sequence: resolve a project, upload the ELF, start the run, wait for the job, then download artifacts.
Your agent’s MCP client discovers the exact tool names and parameters live; the shapes below match the platform’s current workflow.Cross-compilation happens on your side.
Chiplab runs the ELF as-is.
Project
A project holds the uploads and runs, so the next session can continue the same work. Everyone with access to the project sees it.
The id is server-minted. Your agent resolves it once, from context, from list_projects, or by calling create_project, and passes that same id on every later call.
list_projects returns each project’s project_id, name, and description.
create_project takes a name and an optional description.
update_project changes the name or the description. Omit either field to leave it unchanged. The id stays the same.
delete_project removes that project for everyone who can access it.
Upload
issue_upload_ticket takes the project_id and returns:
upload_url: a presigned URL, valid for 10 minutes. Your agent PUTs the raw ELF to it. The URL needs no auth header.
artifact_id: the identifier to pass to run.
The binary must be a compiled ELF for the target chip.
Use an artifact_id with the same project_id it was issued under.
Starting a run
string
required
The project this run belongs to, from create_project. Ids look like project_....
string
required
The firmware to run, from issue_upload_ticket.
object
required
The virtual board to boot. This is an object, not a string. model is one of the board slugs on Boards. uarts is required: the list of UART names to capture, for example ["usart2"]. Only those peripherals are written into the captured output.
run returns as soon as the simulation has started.
string
Identifier for this simulation run. Later calls refer to it as a job_id.
UART output is ready once the job finishes.
Your agent calls wait_for_job with the run_id as job_id.
string
required
The run_id returned by run, or a job id from an earlier listing.
number
How many seconds to wait. The server caps this value.
string
running, succeeded, or failed. succeeded means Chiplab completed the run. It does not mean your firmware behaved: a firmware that panics or faults still returns succeeded. Check the uart output for what you expect.
object
The artifact and board the job was started with, so a run from an earlier session can be recognized without the call that started it.
object
Present when status is succeeded. Includes an artifacts list naming the files the run produced, such as uart.
string
Present when status is failed. What went wrong.
boolean
True when status is still running because the wait ended before the job finished.
A response with status: "running" and timed_out: true means the run is still going.
wait_for_job is read-only, so calling it again on a finished run returns the same response immediately.
To read an artifact, your agent calls issue_download_ticket with the job_id and an artifact_name from that artifacts list.
The response is a presigned download_url.
A GET of that URL returns the artifact bytes, with no auth header.uart is the captured UART output from the peripherals named in board.uarts.
Earlier runs
Earlier runs stay reachable in a later session.
list_jobs takes the project_id and optionally:
string
run to list only runs. Omit it to list every job, including test suite runs.
string
An RFC 3339 timestamp. Only jobs started before this time are returned. When more_available is true, pass the created_at of the last job in the page to continue.
Each entry has a job_id, a status, and a created_at, most recently started first.
Pass the job_id to wait_for_job to read what that run produced.
Limits
A run lasts up to 5 seconds of virtual time.
Last modified on October 5, 2026
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Chiplab Docs","description":"Chiplab is an MCP server that runs firmware on virtual STM32 and Nordic nRF52 chips, letting AI coding agents run embedded code on virtual boards with no hardware.","colors":{"primary":"#6C7B42","light":"#A8B87A","dark":"#6C7B42"},"logo":{"light":"https://mintcdn.com/chiplab/BuDJQgMgm-wl0Q4Z/images/chiplab-logo.svg?fit=max\u0026auto=format\u0026n=BuDJQgMgm-wl0Q4Z\u0026q=85\u0026s=4608b31e0af23cf3f242faee01550fde","dark":"https://mintcdn.com/chiplab/BuDJQgMgm-wl0Q4Z/images/chiplab-logo(white).svg?fit=max\u0026auto=format\u0026n=BuDJQgMgm-wl0Q4Z\u0026q=85\u0026s=e24db1ed688ee8dd056cf6fc4748fe76"},"favicon":{"light":"https://mintcdn.com/chiplab/JrNuTd-49zshcgPf/images/logo.png?fit=max\u0026auto=format\u0026n=JrNuTd-49zshcgPf\u0026q=85\u0026s=e7d4e337c30f079ccf04443e6754a2da","dark":"https://mintcdn.com/chiplab/JrNuTd-49zshcgPf/images/logo.png?fit=max\u0026auto=format\u0026n=JrNuTd-49zshcgPf\u0026q=85\u0026s=e7d4e337c30f079ccf04443e6754a2da"},"appearance":{"strict":false},"navbar":{"links":[{"href":"/changelog","label":"Changelog"}],"primary":{"type":"button","label":"Sign in","href":"https://chiplab.veecle.ai/?utm_source=docs\u0026utm_medium=navbar"}},"footer":{"socials":{"github":"https://github.com/veecle/chiplab","x":"https://x.com/veecle_chiplab","discord":"https://discord.com/invite/F6GwZJ6ktP"},"links":[{"header":"Veecle ","items":[{"label":"Website","href":"https://veecle.ai/?utm_source=docs\u0026utm_medium=footer"},{"label":"Chiplab","href":"https://chiplab.veecle.ai/?utm_source=docs\u0026utm_medium=footer"}]},{"header":"Legal ","items":[{"label":"Imprint","href":"https://veecle.ai/imprint?utm_source=docs\u0026utm_medium=footer"},{"label":"Privacy","href":"https://veecle.ai/privacy?utm_source=docs\u0026utm_medium=footer"},{"label":"Terms","href":"https://chiplab.veecle.ai/terms?utm_source=docs\u0026utm_medium=footer"}]}]},"seo":{"metatags":{"google-site-verification":"gH0L6TghOSodPjluEJOv59nfAo7D5MugjASnSNI3ZCw","twitter:site":"@veecle_chiplab","og:site_name":"Chiplab Docs"},"indexing":"all"},"fonts":{"heading":{"family":"Bricolage Grotesque","weight":500}},"icons":{"library":"fontawesome"},"styling":{"eyebrows":"breadcrumbs","latex":false},"integrations":{"cookies":{"key":"veecle_analytics_consent","value":"granted"}},"contextual":{"options":["copy"],"display":"header"},"thumbnails":{"fonts":{"family":"Inter"}},"metadata":{"timestamp":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"chiplab","hasAudioNarration":false,"actualSubdomain":"chiplab","customDomains":["docs.veecle.ai"],"gitSource":{"type":"github","owner":"veecle","repo":"chiplab-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"edits":false,"thumbs":true,"issues":false,"agentFeedback":true},"entitlements":{},"buildId":"6ae8b9c026d449f6e4d8ef53","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Get started","count":11},{"language":"default","tag":"Tools","count":3},{"language":"default","tag":"Guides","count":3},{"language":"default","tag":"Hardware","count":2},{"language":"default","tag":"Account","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":".framework-matrix table :is(th,td){min-width:0}.boards-table table :is(th,td){min-width:0}"}]}
{"page":{"pagePath":"tools/run","slug":"/tools/run","pageMetadata":{"title":"run","sidebarTitle":"run","description":"Run compiled firmware on a chip-accurate virtual board and read what it printed, with no hardware on your desk.","href":"/tools/run"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Run compiled firmware on a chip-accurate virtual board and read what it printed, with no hardware on your desk.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,ParamField,ResponseField,Tab,Tabs,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(Tabs,{children:[_jsxs(Tab,{title:`You`,id:`you`,\"data-child-heading-ids\":`[\"when-to-use-it\",\"ask-your-agent\",\"what-you-get-back\",\"chip-accuracy\",\"knowledge-corpus\"]`,children:[_jsxs(_components.p,{children:[`Chiplab executes your firmware on a chip-accurate virtual board and returns the UART output you asked to capture, no physical hardware required.\nCross-compilation happens on your side.\nChiplab runs the ELF as-is.\nThe simulation platform today is `,_jsx(_components.a,{href:`https://renode.io`,children:`Renode`}),`, with `,_jsx(_components.a,{href:`https://www.qemu.org`,children:`QEMU`}),` and more planned.`]}),_jsx(Heading,{level:`2`,id:`when-to-use-it`,children:`When to use it`}),_jsxs(_components.p,{children:[`Use a run when you want the printed output. When you need a pass or fail for each test, use `,_jsx(_components.a,{href:`/tools/test`,children:`test`}),`.`]}),_jsx(Heading,{level:`2`,id:`ask-your-agent`,children:`Ask your agent`}),_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Run this firmware on the STM32F4 Discovery and capture usart2.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(Tip,{children:_jsx(_components.p,{children:`Not sure which board fits your firmware? Ask Chiplab about individual board specs; board recommendation tooling is on the way.`})}),_jsx(Heading,{level:`2`,id:`what-you-get-back`,children:`What you get back`}),_jsxs(_components.p,{children:[`You get the captured UART output. `,_jsx(_components.code,{children:`succeeded`}),` means Chiplab completed the run. It does not mean your firmware behaved: a firmware that panics or faults still returns `,_jsx(_components.code,{children:`succeeded`}),`. Check the `,_jsx(_components.code,{children:`uart`}),` output for what you expect.`]}),_jsx(_components.p,{children:`A run lasts up to 5 seconds of virtual time.`}),_jsx(Heading,{level:`2`,id:`chip-accuracy`,children:`Chip accuracy`}),_jsx(_components.p,{children:`Each virtual board runs your exact binary against a chip-accurate model of the target’s peripherals, memory map, and interrupt controller.`}),_jsx(Note,{children:_jsx(_components.p,{children:`Peripheral coverage keeps growing. If your firmware depends on a peripheral or timing behavior Chiplab doesn’t model yet, ask Chiplab for the current coverage of your board.`})}),_jsx(Heading,{level:`2`,id:`knowledge-corpus`,children:`Knowledge corpus`}),_jsxs(_components.p,{children:[`Every run deposits observed behavior into Chiplab’s `,_jsx(_components.a,{href:`/introduction#knowledge-corpus`,children:`knowledge corpus`}),`. Your firmware code and binaries are not part of it.`]})]}),_jsxs(Tab,{title:`Agents`,id:`agents`,\"data-child-heading-ids\":`[\"project\",\"upload\",\"starting-a-run\",\"waiting-for-the-job\",\"reading-the-output\",\"earlier-runs\",\"limits\"]`,children:[_jsx(_components.p,{children:`The agent workflow is a short sequence: resolve a project, upload the ELF, start the run, wait for the job, then download artifacts.\nYour agent’s MCP client discovers the exact tool names and parameters live; the shapes below match the platform’s current workflow.`}),_jsx(_components.p,{children:`Cross-compilation happens on your side.\nChiplab runs the ELF as-is.`}),_jsx(Heading,{level:`2`,id:`project`,children:`Project`}),_jsxs(_components.p,{children:[`A project holds the uploads and runs, so the next session can continue the same work. Everyone with access to the project sees it.\nThe id is server-minted. Your agent resolves it once, from context, from `,_jsx(_components.code,{children:`list_projects`}),`, or by calling `,_jsx(_components.code,{children:`create_project`}),`, and passes that same id on every later call.`]}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`list_projects`}),` returns each project’s `,_jsx(_components.code,{children:`project_id`}),`, `,_jsx(_components.code,{children:`name`}),`, and `,_jsx(_components.code,{children:`description`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`create_project`}),` takes a `,_jsx(_components.code,{children:`name`}),` and an optional `,_jsx(_components.code,{children:`description`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`update_project`}),` changes the `,_jsx(_components.code,{children:`name`}),` or the `,_jsx(_components.code,{children:`description`}),`. Omit either field to leave it unchanged. The id stays the same.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`delete_project`}),` removes that project for everyone who can access it.`]}),`\n`]}),_jsx(Heading,{level:`2`,id:`upload`,children:`Upload`}),_jsxs(_components.p,{children:[_jsx(_components.code,{children:`issue_upload_ticket`}),` takes the `,_jsx(_components.code,{children:`project_id`}),` and returns:`]}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`upload_url`}),`: a presigned URL, valid for 10 minutes. Your agent `,_jsx(_components.code,{children:`PUT`}),`s the raw ELF to it. The URL needs no auth header.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`artifact_id`}),`: the identifier to pass to `,_jsx(_components.code,{children:`run`}),`.`]}),`\n`]}),_jsxs(_components.p,{children:[`The binary must be a compiled ELF for the target chip.\nUse an `,_jsx(_components.code,{children:`artifact_id`}),` with the same `,_jsx(_components.code,{children:`project_id`}),` it was issued under.`]}),_jsx(Heading,{level:`2`,id:`starting-a-run`,children:`Starting a run`}),_jsx(ParamField,{body:`project_id`,type:`string`,required:true,id:`param-project-id`,children:_jsxs(_components.p,{children:[`The project this run belongs to, from `,_jsx(_components.code,{children:`create_project`}),`. Ids look like `,_jsx(_components.code,{children:`project_...`}),`.`]})}),_jsx(ParamField,{body:`artifact_id`,type:`string`,required:true,id:`param-artifact-id`,children:_jsxs(_components.p,{children:[`The firmware to run, from `,_jsx(_components.code,{children:`issue_upload_ticket`}),`.`]})}),_jsx(ParamField,{body:`board`,type:`object`,required:true,id:`param-board`,children:_jsxs(_components.p,{children:[`The virtual board to boot. This is an object, not a string. `,_jsx(_components.code,{children:`model`}),` is one of the board slugs on `,_jsx(_components.a,{href:`/hardware/boards`,children:`Boards`}),`. `,_jsx(_components.code,{children:`uarts`}),` is required: the list of UART names to capture, for example `,_jsx(_components.code,{children:`[\"usart2\"]`}),`. Only those peripherals are written into the captured output.`]})}),_jsxs(_components.p,{children:[_jsx(_components.code,{children:`run`}),` returns as soon as the simulation has started.`]}),_jsx(ResponseField,{name:`run_id`,type:`string`,id:`param-run-id`,children:_jsxs(_components.p,{children:[`Identifier for this simulation run. Later calls refer to it as a `,_jsx(_components.code,{children:`job_id`}),`.`]})}),_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"project_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"project_01...\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"artifact_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"artifact_01...\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"board\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"model\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"stm32f4_discovery\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"uarts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"usart2\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`] }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"run_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"run_01...\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`]})})}),_jsx(Heading,{level:`2`,id:`waiting-for-the-job`,children:`Waiting for the job`}),_jsxs(_components.p,{children:[`UART output is ready once the job finishes.\nYour agent calls `,_jsx(_components.code,{children:`wait_for_job`}),` with the `,_jsx(_components.code,{children:`run_id`}),` as `,_jsx(_components.code,{children:`job_id`}),`.`]}),_jsx(ParamField,{body:`job_id`,type:`string`,required:true,id:`param-job-id`,children:_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`run_id`}),` returned by `,_jsx(_components.code,{children:`run`}),`, or a job id from an earlier listing.`]})}),_jsx(ParamField,{body:`timeout`,type:`number`,id:`param-timeout`,children:_jsx(_components.p,{children:`How many seconds to wait. The server caps this value.`})}),_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`running`}),`, `,_jsx(_components.code,{children:`succeeded`}),`, or `,_jsx(_components.code,{children:`failed`}),`. `,_jsx(_components.code,{children:`succeeded`}),` means Chiplab completed the run. It does not mean your firmware behaved: a firmware that panics or faults still returns `,_jsx(_components.code,{children:`succeeded`}),`. Check the `,_jsx(_components.code,{children:`uart`}),` output for what you expect.`]})}),_jsx(ResponseField,{name:`input`,type:`object`,id:`param-input`,children:_jsx(_components.p,{children:`The artifact and board the job was started with, so a run from an earlier session can be recognized without the call that started it.`})}),_jsx(ResponseField,{name:`result`,type:`object`,id:`param-result`,children:_jsxs(_components.p,{children:[`Present when `,_jsx(_components.code,{children:`status`}),` is `,_jsx(_components.code,{children:`succeeded`}),`. Includes an `,_jsx(_components.code,{children:`artifacts`}),` list naming the files the run produced, such as `,_jsx(_components.code,{children:`uart`}),`.`]})}),_jsx(ResponseField,{name:`error`,type:`string`,id:`param-error`,children:_jsxs(_components.p,{children:[`Present when `,_jsx(_components.code,{children:`status`}),` is `,_jsx(_components.code,{children:`failed`}),`. What went wrong.`]})}),_jsx(ResponseField,{name:`timed_out`,type:`boolean`,id:`param-timed-out`,children:_jsxs(_components.p,{children:[`True when `,_jsx(_components.code,{children:`status`}),` is still `,_jsx(_components.code,{children:`running`}),` because the wait ended before the job finished.`]})}),_jsxs(_components.p,{children:[`A response with `,_jsx(_components.code,{children:`status: \"running\"`}),` and `,_jsx(_components.code,{children:`timed_out: true`}),` means the run is still going.\n`,_jsx(_components.code,{children:`wait_for_job`}),` is read-only, so calling it again on a finished run returns the same response immediately.`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"succeeded\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"result\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"artifacts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"uart\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`] }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(Heading,{level:`2`,id:`reading-the-output`,children:`Reading the output`}),_jsxs(_components.p,{children:[`To read an artifact, your agent calls `,_jsx(_components.code,{children:`issue_download_ticket`}),` with the `,_jsx(_components.code,{children:`job_id`}),` and an `,_jsx(_components.code,{children:`artifact_name`}),` from that `,_jsx(_components.code,{children:`artifacts`}),` list.\nThe response is a presigned `,_jsx(_components.code,{children:`download_url`}),`.\nA `,_jsx(_components.code,{children:`GET`}),` of that URL returns the artifact bytes, with no auth header.`]}),_jsxs(_components.p,{children:[_jsx(_components.code,{children:`uart`}),` is the captured UART output from the peripherals named in `,_jsx(_components.code,{children:`board.uarts`}),`.`]}),_jsx(Heading,{level:`2`,id:`earlier-runs`,children:`Earlier runs`}),_jsxs(_components.p,{children:[`Earlier runs stay reachable in a later session.\n`,_jsx(_components.code,{children:`list_jobs`}),` takes the `,_jsx(_components.code,{children:`project_id`}),` and optionally:`]}),_jsx(ParamField,{body:`kind`,type:`string`,id:`param-kind`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`run`}),` to list only runs. Omit it to list every job, including test suite runs.`]})}),_jsx(ParamField,{body:`created_before`,type:`string`,id:`param-created-before`,children:_jsxs(_components.p,{children:[`An RFC 3339 timestamp. Only jobs started before this time are returned. When `,_jsx(_components.code,{children:`more_available`}),` is true, pass the `,_jsx(_components.code,{children:`created_at`}),` of the last job in the page to continue.`]})}),_jsxs(_components.p,{children:[`Each entry has a `,_jsx(_components.code,{children:`job_id`}),`, a `,_jsx(_components.code,{children:`status`}),`, and a `,_jsx(_components.code,{children:`created_at`}),`, most recently started first.\nPass the `,_jsx(_components.code,{children:`job_id`}),` to `,_jsx(_components.code,{children:`wait_for_job`}),` to read what that run produced.`]}),_jsx(Heading,{level:`2`,id:`limits`,children:`Limits`}),_jsx(_components.p,{children:`A run lasts up to 5 seconds of virtual time.`})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"run","sidebarTitle":"run","description":"Run compiled firmware on a chip-accurate virtual board and read what it printed, with no hardware on your desk.","href":"/tools/run"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"When to use it","slug":"when-to-use-it","depth":2,"children":[],"tabId":"you"},{"title":"Ask your agent","slug":"ask-your-agent","depth":2,"children":[],"tabId":"you"},{"title":"What you get back","slug":"what-you-get-back","depth":2,"children":[],"tabId":"you"},{"title":"Chip accuracy","slug":"chip-accuracy","depth":2,"children":[],"tabId":"you"},{"title":"Knowledge corpus","slug":"knowledge-corpus","depth":2,"children":[],"tabId":"you"},{"title":"Project","slug":"project","depth":2,"children":[],"tabId":"agents"},{"title":"Upload","slug":"upload","depth":2,"children":[],"tabId":"agents"},{"title":"Starting a run","slug":"starting-a-run","depth":2,"children":[],"tabId":"agents"},{"title":"Waiting for the job","slug":"waiting-for-the-job","depth":2,"children":[],"tabId":"agents"},{"title":"Reading the output","slug":"reading-the-output","depth":2,"children":[],"tabId":"agents"},{"title":"Earlier runs","slug":"earlier-runs","depth":2,"children":[],"tabId":"agents"},{"title":"Limits","slug":"limits","depth":2,"children":[],"tabId":"agents"}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/chiplab/6655fcb9e81cf18e/posthog.js"],"subdomain":"chiplab","siteName":"Chiplab Docs","title":"run - Chiplab Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T13:17:43.558Z","gitLastModified":"2026-10-05T13:17:22.000Z","originalFileLocation":"tools/run.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Run compiled firmware on a chip-accurate virtual board and read what it printed, with no hardware on your desk.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Chiplab Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/chiplab/aDlZDRKy7Um2cRsd/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/chiplab/aDlZDRKy7Um2cRsd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/chiplab/aDlZDRKy7Um2cRsd/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/chiplab/aDlZDRKy7Um2cRsd/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/chiplab/aDlZDRKy7Um2cRsd/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/chiplab/aDlZDRKy7Um2cRsd/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/chiplab/aDlZDRKy7Um2cRsd/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/chiplab/aDlZDRKy7Um2cRsd/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/chiplab/aDlZDRKy7Um2cRsd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"run - Chiplab Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Run compiled firmware on a chip-accurate virtual board and read what it printed, with no hardware on your desk.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Chiplab Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.veecle.ai/tools/run\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://chiplab.mintlify.site/_mintlify/api/og/v2?division=Tools\u0026amp;title=run\u0026amp;description=Run+compiled+firmware+on+a+chip-accurate+virtual+board+and+read+what+it+printed%2C+with+no+hardware+on+your+desk.\u0026amp;theme=e0a6b6d0f32f2fe5d86ca665\u0026amp;signature=89d8ddf56ac3f87e64209e2a326efb6629903ab0a9c8160cc2c63c036c7e9b13\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"run - Chiplab Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Run compiled firmware on a chip-accurate virtual board and read what it printed, with no hardware on your desk.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://chiplab.mintlify.site/_mintlify/api/og/v2?division=Tools\u0026amp;title=run\u0026amp;description=Run+compiled+firmware+on+a+chip-accurate+virtual+board+and+read+what+it+printed%2C+with+no+hardware+on+your+desk.\u0026amp;theme=e0a6b6d0f32f2fe5d86ca665\u0026amp;signature=89d8ddf56ac3f87e64209e2a326efb6629903ab0a9c8160cc2c63c036c7e9b13\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/chiplab/aDlZDRKy7Um2cRsd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Chiplab Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6C7B42\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"gH0L6TghOSodPjluEJOv59nfAo7D5MugjASnSNI3ZCw\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.veecle.ai/tools/run\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/tools/run.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.veecle.ai/#organization\",\"name\":\"Chiplab Docs\",\"url\":\"https://docs.veecle.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/chiplab/BuDJQgMgm-wl0Q4Z/images/chiplab-logo.svg?fit=max\u0026auto=format\u0026n=BuDJQgMgm-wl0Q4Z\u0026q=85\u0026s=4608b31e0af23cf3f242faee01550fde\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.veecle.ai#website\",\"name\":\"Chiplab Docs\",\"url\":\"https://docs.veecle.ai\",\"publisher\":{\"@id\":\"https://docs.veecle.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.veecle.ai/tools/run#webpage\",\"url\":\"https://docs.veecle.ai/tools/run\",\"name\":\"run\",\"description\":\"Run compiled firmware on a chip-accurate virtual board and read what it printed, with no hardware on your desk.\",\"dateModified\":\"2026-10-05T13:17:22.000Z\",\"isPartOf\":{\"@id\":\"https://docs.veecle.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.veecle.ai/tools/run#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.veecle.ai/tools/run#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Tools\",\"item\":\"https://docs.veecle.ai/tools/ask\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"run\",\"item\":\"https://docs.veecle.ai/tools/run\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.veecle.ai/tools/run#article\",\"headline\":\"run\",\"name\":\"run\",\"description\":\"Run compiled firmware on a chip-accurate virtual board and read what it printed, with no hardware on your desk.\",\"url\":\"https://docs.veecle.ai/tools/run\",\"mainEntityOfPage\":{\"@id\":\"https://docs.veecle.ai/tools/run#webpage\"},\"dateModified\":\"2026-10-05T13:17:22.000Z\",\"publisher\":{\"@id\":\"https://docs.veecle.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.veecle.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Chiplab Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Chiplab Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/tools/run.md","siteName":"Chiplab Docs","nav":{"global":null,"groups":[{"group":"Get started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Core concepts","href":"/concepts"},{"title":"Set up Chiplab","href":"/quickstart"},{"title":"Connect an agent","sidebarTitle":"Connect an agent","href":"/agents/overview"},{"title":"Cursor","hidden":true,"href":"/agents/cursor"},{"title":"OpenCode","hidden":true,"href":"/agents/opencode"},{"title":"Claude Code","hidden":true,"href":"/agents/claude-code"},{"title":"Claude Desktop","hidden":true,"href":"/agents/claude-desktop"},{"title":"VS Code","hidden":true,"href":"/agents/vs-code"},{"title":"Codex","hidden":true,"href":"/agents/codex"},{"title":"Chiplab CLI","sidebarTitle":"Use the CLI","href":"/platform/cli"}]},{"group":"Guides","pages":[{"title":"Test firmware before the board arrives","sidebarTitle":"Test without hardware","href":"/use-cases/test-without-hardware"},{"title":"Find out why firmware crashes","sidebarTitle":"Debug crashes","href":"/use-cases/debug-a-crash"},{"title":"Check pull requests on a virtual board","sidebarTitle":"Test in CI","href":"/use-cases/ci-on-every-pr"}]},{"group":"Tools","pages":[{"title":"ask","sidebarTitle":"ask","description":"Look up how Chiplab works: supported boards, the upload and run flow, credits, and chip-specific fixes learned from real runs.","href":"/tools/ask"},{"title":"run","sidebarTitle":"run","href":"/tools/run"},{"title":"test","sidebarTitle":"test","description":"Check that your firmware does what it should on a virtual board.","href":"/tools/test"}]},{"group":"Hardware","pages":[{"title":"Boards","sidebarTitle":"Boards","href":"/hardware/boards"},{"title":"Frameworks","sidebarTitle":"Frameworks","href":"/hardware/frameworks"}]},{"group":"Account","pages":[{"title":"API keys","href":"/platform/api-keys"},{"title":"Usage","href":"/platform/usage"}]}]},"basePath":"","title":"run - Chiplab Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}