Getting started

Quickstart

Get your first agent running on circuitnova ai in under five minutes.

1. Install the SDK

Add the core package to any Node or TypeScript project.

bash
npm install @circuitnova/core

2. Define an agent

Wrap any framework — here we use the native SDK for clarity.

ts
import { agent, tool } from "@circuitnova/core";

const search = tool({
  name: "search",
  run: async ({ q }) => fetch(`https://duckduckgo.com/?q=${q}`).then(r => r.text()),
});

export const researcher = agent({
  name: "researcher",
  model: "anthropic/claude-3-5-sonnet",
  tools: [search],
  system: "You are a thorough research assistant.",
});

3. Run it

Locally first — circuitnova captures the full trace either way.

ts
import { runtime } from "@circuitnova/core";
import { researcher } from "./researcher";

const run = await runtime.run(researcher, {
  input: "Summarize the latest research on agent orchestration.",
});

console.log(run.output);
console.log(run.trace.url);  // https://app.circuitnova.ai/runs/run_8c2a

4. Deploy

One command. Cloud, self-host, or BYOC.

bash
$ circuitnova deploy researcher

✓ uploaded  •  ✓ provisioned  •  ✓ live
→ https://api.circuitnova.ai/r/researcher