Skip to content
runlog_docsDashboard ->
Getting started / Quickstartv

Docs/Getting started/Quickstart

Quickstart

Install the SDK, define one tool and run your first verified agent in about five minutes.

On this page+

You need Node 22+ or Python 3.11+, and an API key from the dashboard.

Install the SDK

Add the package to an existing project.

npm i @runlog/sdk
export RUNLOG_KEY=rl_test_...

Define a tool

Tools are typed. Inputs are validated before every call.

import { tool } from "@runlog/sdk";

export const createPr = tool("repo.create_pr", {
  input: { branch: "string", title: "string" },
  approval: "required",
});

Run your agent

Every step streams back as it happens.

npx runlog dev
> run_8f3a21  6 steps  verified in 6.5s

Options

option type default description
budget.usd number - Hard spend ceiling per run
budget.steps number 25 Max steps before the run stops
verify function - Return true to ship the result
Was this page helpful?