History

Ajax Davis 4e3cb78ba4 feat(sprites): add SPRITES_TOKEN env requirement to package metadata All sprites tools require a SPRITES_TOKEN to authenticate with sprites.dev. This adds the env field to the tpmjs metadata so Omega can warn users about missing API keys.		2026-01-25 12:23:43 +10:00
..
src	fix(sprites-list): add 'warm' to valid sprite statuses	2026-01-16 18:00:58 +10:00
CHANGELOG.md	feat(sprites): add SPRITES_TOKEN env requirement to package metadata	2026-01-25 12:23:43 +10:00
package.json	feat(sprites): add SPRITES_TOKEN env requirement to package metadata	2026-01-25 12:23:43 +10:00
README.md	feat: add READMEs to sprites packages and fix blocks.yml schema	2026-01-14 16:22:39 +10:00
tsconfig.json	refactor: replace exportName with name throughout codebase	2026-01-14 14:18:36 +10:00
tsup.config.ts	refactor: replace exportName with name throughout codebase	2026-01-14 14:18:36 +10:00

README.md

@tpmjs/sprites-list

List all sprites in your account with their current status and metadata.

Installation

npm install @tpmjs/sprites-list

Requirements

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

Usage

import { spritesListTool } from '@tpmjs/sprites-list';

const result = await spritesListTool.execute({});

console.log(result);
// {
//   sprites: [
//     { name: 'my-sandbox', status: 'running', createdAt: '2024-01-15T10:30:00Z' },
//     { name: 'test-env', status: 'stopped', createdAt: '2024-01-14T08:00:00Z' }
//   ],
//   count: 2
// }

Input Parameters

This tool takes no input parameters.

Output

Field	Type	Description
`sprites`	`Sprite[]`	Array of sprites in the account
`count`	`number`	Total number of sprites

Sprite Object

Field	Type	Description
`name`	`string`	Unique name of the sprite
`status`	`'creating' \| 'running' \| 'stopped' \| 'error'`	Current status
`createdAt`	`string`	ISO 8601 timestamp of creation
`runtime`	`string?`	Optional runtime configuration
`metadata`	`object?`	Optional custom metadata

Error Handling

The tool throws errors in these cases:

SPRITES_TOKEN environment variable is not set
Invalid or expired API token (HTTP 401)
Network timeout (30 second limit)
API errors with descriptive messages

License

MIT