Installation & Usage

Install this tool and use it with the AI SDK

1. Install the package

npm install @tpmjs/tools-sprites-checkpoint-create

pnpm add @tpmjs/tools-sprites-checkpoint-create

yarn add @tpmjs/tools-sprites-checkpoint-create

bun add @tpmjs/tools-sprites-checkpoint-create

deno add npm:@tpmjs/tools-sprites-checkpoint-create

2. Import the tool

import { spritesCheckpointCreateTool } from '@tpmjs/tools-sprites-checkpoint-create';

3. Use with AI SDK

import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { spritesCheckpointCreateTool } from '@tpmjs/tools-sprites-checkpoint-create';

const result = await generateText({
  model: openai('gpt-4o'),
  tools: { spritesCheckpointCreateTool },
  prompt: 'Your prompt here...',
});

console.log(result.text);

Parameters

Available configuration options

Auto-extracted

name

Required

Type: string

Name of the sprite to checkpoint

checkpointName

Optional

Type: string

Optional human-readable name for the checkpoint

Schema extracted: 1/16/2026, 3:45:31 AM

README

@tpmjs/sprites-checkpoint-create

Create a point-in-time snapshot (checkpoint) of a sprite's filesystem state for later restoration.

Installation

npm install @tpmjs/sprites-checkpoint-create

Requirements

SPRITES_TOKEN environment variable - Get your token from https://sprites.dev

Usage

import { spritesCheckpointCreateTool } from '@tpmjs/sprites-checkpoint-create';

const result = await spritesCheckpointCreateTool.execute({
  name: 'my-sandbox',
  checkpointName: 'before-experiment'
});

console.log(result);
// {
//   id: 'chk_abc123',
//   name: 'before-experiment',
//   createdAt: '2024-01-15T10:30:00Z',
//   size: 52428800
// }

Input Parameters

Parameter	Type	Required	Description
`name`	`string`	Yes	Name of the sprite to checkpoint
`checkpointName`	`string`	No	Optional human-readable name for the checkpoint

Output

Field	Type	Description
`id`	`string`	Unique checkpoint identifier (use this for restore)
`name`	`string?`	Human-readable checkpoint name if provided
`createdAt`	`string`	ISO 8601 timestamp of creation
`size`	`number?`	Checkpoint size in bytes

Use Cases

Save state before risky operations
Create restore points for experiments
Backup filesystem before installing packages
Version control for sprite state

Error Handling

The tool throws errors in these cases:

SPRITES_TOKEN environment variable is not set
Sprite not found (HTTP 404)
Invalid or expired API token (HTTP 401)
Network timeout (120 second limit for large checkpoints)
API errors with descriptive messages

License

MIT

spritesCheckpointCreateTool

This tool is currently broken

Interactive Playground