Pixelpushdocs
Search the docs…⌘K
v2.4 12.3k
DocsGetting startedInstallation

Installation

A tiny, dependency-free toolkit for drawing crisp pixel-perfect UI in the browser. Install the client, configure a single object, and start making fully-typed requests. Everything below is copy-paste ready — no scaffolding required.

Requires Node 18+

The runtime ships native ESM and the Fetch API. For older environments, pull in a polyfill before importing the client.

npmpnpmyarnbun
terminalbash
1$ npm install @pixelpush/core

Configuration

Create a client once and reuse it across your app. The configuration object is fully typed; your editor will autocomplete every field.

client.tstypescript
1import { createClient } from "@pixelpush/core"
2 
3const client = createClient({
4 apiKey: process.env.API_KEY,
5 region: "us-east",
6 timeout: 5000,
7})
8 
9const { data } = await client.query("projects")

Parameters

NameTypeDefaultDescription
apiKeystringSecret key used to authenticate every request.
region"us-east" | "eu""us-east"Edge region the client routes traffic through.
timeoutnumber10000Per-request timeout in milliseconds.
retriesnumber2Automatic retry count for idempotent calls.
cachebooleantrueEnable the in-memory response cache.

Response shape

Every successful call resolves to a discriminated union you can narrow safely:

response.jsonjson
1{
2 "ok": true,
3 "count": 3,
4 "data": [
5 { "id": "prj_8fa2", "name": "Atlas" }
6 ]
7}
Keep going

Guides

Hand-written walkthroughs for the most common things you’ll build with Pixelpush.

Draw your first sprite

Spin up a canvas, load an 8x8 tile, and stamp it to the grid with one call. No build step, no fuss.

Read guide

Palette swapping

Bind named palettes and recolor entire scenes at runtime — fade a screen to amber CRT or flip to night mode in a frame.

Read guide

Snapping the grid

Lock every coordinate to the pixel grid so edges stay hard and your art never blurs across device scales.

Read guide
pixelpush — zsh
$pixelpush init my-app
✓ scaffolding project
✓ installing dependencies
ready · http://localhost:3000
$pixelpush deploy --prod
› building 4 routes
deployed in 8.2s → atlas.app
$
Pixelpush

A tiny, dependency-free toolkit for drawing crisp pixel-perfect UI in the browser.

DocsQuickstartGuidesAPI referenceExamples
ResourcesChangelogStatusRoadmapDiscord
CompanyBlogCareersSecurityContact
© 2026 Pixelpush — an original demo built in the Retro style for staqd. MIT licensed. v2.4.0 · build 8fa2c3e · node 20.11