SDK reference
Every hook, event and option
The full surface of the Codual client and the events a run emits.
Configuration
Settings in codual.config.ts, read once per run.
repositorystring- Repository the agents read and open pull requests against.
targetsTarget[]- Platforms to build for. Inferred from the prompt when omitted.
designSystemstring- Path to the components and tokens to reuse.
reviewersstring[]- Who gets requested on every pull request the agents open.
Run lifecycle events
Webhook payloads, delivered in the order a run reaches them.
run.startedRunEvent- A prompt was accepted and a run has been queued.
run.plannedPlanEvent- The plan is ready, before any code is written.
run.builtBuildEvent- Source has been written and compiled.
qa.passedQaEvent- Device QA completed with no outstanding findings.
qa.failedQaEvent- Device QA found something it could not fix automatically.
release.submittedReleaseEvent- The build was submitted to the stores.
Methods
The client surface, for driving runs from your own tooling.
codual.run(prompt)Promise<Run>- Start a run from a plain-language description.
codual.plan(prompt)Promise<Plan>- Produce a plan without building anything.
codual.get(runId)Promise<Run>- Fetch the current state of a run.
codual.cancel(runId)Promise<void>- Stop a run that is in flight.