Memory

Run the first project.

Run locallyTry hosted

The SDK is private today. Run its checked-in example, or try hosted Memory here.

Run these commands.

  1. Prepare SDKpnpm examples:prepare-sdk

    Build the current private SDK package from the Memory repository.

  2. Install examplecd examples/sdk-quickstart && pnpm install

    Install the checked-in model-aware example.

  3. Build Assemblypnpm exec memory synth --entry memory.model.ts --out memory.out

    Create the exact Assembly used by every later step.

  4. Check modelpnpm exec memory check --assembly memory.out --env local --yes

    Check that exact Assembly against Memory.

  5. Deploypnpm exec memory deploy --assembly memory.out --env local --yes

    Check once more, then apply that Assembly.

Start local. Move to hosted when needed.

Need

Node, pnpm, the Memory repository, and a running Memory API.

Time

About 10 minutes for the first model.

Account

Not needed to run locally. Needed to keep hosted projects.

Cloud

Starts only when you choose hosted Memory.

Use Memory from app code.

import { createMemoryModelClient, MemoryClient } from '@memory/sdk'
import { createMemoryClientOptionsFromEnvironment, resolveMemoryEnvironment } from '@memory/sdk/config'
import { model } from './memory.model.js'

const environment = await resolveMemoryEnvironment()
const client = new MemoryClient(createMemoryClientOptionsFromEnvironment(environment))

export const memory = createMemoryModelClient(client, model)

Choose the smallest useful template.

minimal

Smallest model. Use it to see the parts.

todo

First working app. Use it to query and deploy.

confluence

Sync example. Use it when outside data matters.