quickstart.mdx

title	Quick Start
description	Get up and running with jam-nodes in minutes.

Installation

```bash npm npm install @jam-nodes/core @jam-nodes/nodes zod ```

yarn add @jam-nodes/core @jam-nodes/nodes zod

pnpm add @jam-nodes/core @jam-nodes/nodes zod

Basic Usage

1. Create a Registry

import { NodeRegistry } from '@jam-nodes/core';
import { builtInNodes } from '@jam-nodes/nodes';

const registry = new NodeRegistry();
registry.registerAll(builtInNodes);

2. Create an Execution Context

import { ExecutionContext } from '@jam-nodes/core';

const ctx = new ExecutionContext({ userName: 'World' });

3. Run a Node

const executor = registry.getExecutor('http_request');
const result = await executor(
  { url: 'https://api.example.com/data', method: 'GET' },
  ctx.toNodeContext('user-123', 'wf-456')
);

console.log(result.success, result.output);

4. Use Variable Interpolation

ctx.setVariable('apiUrl', 'https://api.example.com');

const input = ctx.interpolateObject({
  url: '{{apiUrl}}/users',
  method: 'GET',
});
// { url: 'https://api.example.com/users', method: 'GET' }

Next Steps

Understand the type system and registry. Explore all 16 built-in nodes. Build and register your own nodes. Test nodes interactively with the CLI or web playground.